ProMailerMessage class

ProMailer Message

aliased properties

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.

Common
Properties

Common

Name	Return	Summary
ProMailerMessage::get() ProMailerMessage::get($key) ProMailerMessage::get($key)	None
ProMailerMessage::getDefaultsArray() ProMailerMessage::getDefaultsArray() ProMailerMessage::getDefaultsArray()	`array`	Get default values
ProMailerMessage::getList() ProMailerMessage::getList() ProMailerMessage::getList()	`ProMailerList` `null`	Get the list this message will send to
ProMailerMessage::getSubscriber() ProMailerMessage::getSubscriber() ProMailerMessage::getSubscriber()	`ProMailerSubscriber` `null`	Get the subscriber this message will send to
ProMailerMessage::set() ProMailerMessage::set($key, $value) ProMailerMessage::set($key, $value)	None
ProMailerMessage::setList() ProMailerMessage::setList(ProMailerList $list) ProMailerMessage::setList(ProMailerList $list)	`$this`	Set the list this message will send to
ProMailerMessage::setSubscriber() ProMailerMessage::setSubscriber(ProMailerSubscriber $subscriber) ProMailerMessage::setSubscriber(ProMailerSubscriber $subscriber)	`$this`	Set the subscriber this message will send to

Properties

Name	Return	Summary
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::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::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.251