ProMailerMessage class

Located in file /site/modules/ProMailer/ProMailerMessage.php

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProMailerMessage class also inherits all the methods and properties of: ProMailerType, WireData and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
ProMailerMessage::body_html string 
ProMailerMessage::body_page int 
ProMailerMessage::body_source int 
ProMailerMessage::body_text string 
ProMailerMessage::body_type int 
ProMailerMessage::created int 
ProMailerMessage::custom array 
ProMailerMessage::flags int Either 0 or ProMailer::messageFlagsQueueSend 
ProMailerMessage::from_email string From email address 
ProMailerMessage::from_name string Optional from name 
ProMailerMessage::get($key)
mixed nullRetrieve the value for a previously set property, or retrieve an API variable 
ProMailerMessage::getDefaultsArray()
arrayGet default values 
ProMailerMessage::getList()
ProMailerList nullGet the list this message will send to 
ProMailerMessage::getSubscriber()
ProMailerSubscriber nullGet the subscriber this message will send to 
ProMailerMessage::id int 
ProMailerMessage::last_sent int 
ProMailerMessage::list ProMailerList null List this message sends to 
ProMailerMessage::list_id int 
ProMailerMessage::mailer string 
ProMailerMessage::reply_email string Optional reply-to email address (if different from from_email) 
ProMailerMessage::send_qty null int 
ProMailerMessage::set($key, $value)
WireData ProMailerTypeSet value 
ProMailerMessage::setList(ProMailerList $list)
$thisSet the list this message will send to 
ProMailerMessage::setSubscriber(ProMailerSubscriber $subscriber)
$thisSet the subscriber this message will send to 
ProMailerMessage::subject string 
ProMailerMessage::subscriber ProMailerSubscriber null Next subscriber this message sends to 
ProMailerMessage::subscriber_id int 
ProMailerMessage::throttle_secs null int 
ProMailerMessage::title string 

Additional methods and properties

In addition to the methods and properties above, ProMailerMessage also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.244

Newest forum posts

Latest news

  • ProcessWire Weekly #560
    In the 560th issue of ProcessWire Weekly we'll check out the latest core updates, cover newly released ProcessWire modules, and more. Read on!
    Weekly.pw / 1 February 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK