ProMailerSubscriber class

ProMailer Subscriber

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 ProMailerSubscriber class also inherits all the methods and properties of: ProMailerType, WireData and Wire.

Common
Properties

Common

Name	Return	Summary
ProMailerSubscriber::get() ProMailerSubscriber::get($key) ProMailerSubscriber::get($key)	None
ProMailerSubscriber::getCustom() ProMailerSubscriber::getCustom($name) ProMailerSubscriber::getCustom($name)	None
ProMailerSubscriber::getDefaultsArray() ProMailerSubscriber::getDefaultsArray() ProMailerSubscriber::getDefaultsArray()	None
ProMailerSubscriber::getList() ProMailerSubscriber::getList() ProMailerSubscriber::getList()	`ProMailerList` `null`	Get the list this subscriber belongs to
ProMailerSubscriber::gravatar() ProMailerSubscriber::gravatar() ProMailerSubscriber::gravatar($size = 80, $attr = '')	None
ProMailerSubscriber::set() ProMailerSubscriber::set($key, $value) ProMailerSubscriber::set($key, $value)	None
ProMailerSubscriber::setCustom() ProMailerSubscriber::setCustom(string $name, mixed $value) ProMailerSubscriber::setCustom(string $name, mixed $value)	`bool`	Set value for custom field while also sanitizing it
ProMailerSubscriber::setList() ProMailerSubscriber::setList(ProMailerList $list) ProMailerSubscriber::setList(ProMailerList $list)	`$this`	Set the list for this subscriber

Properties

Name	Return	Summary
ProMailerSubscriber::code	`string`	Confirmation code for this subscriber, used for confirming subscribe/unsubscribe
ProMailerSubscriber::confirmed	`int`	Is subscriber opt-in confirmed? Contains timestamp of confirmation time when confirmed
ProMailerSubscriber::created	`int`	Timestamp of when this subscriber was created
ProMailerSubscriber::custom	`array`
ProMailerSubscriber::email	`string`
ProMailerSubscriber::flags	`int`
ProMailerSubscriber::id	`int`
ProMailerSubscriber::list	`ProMailerList` `null`	List that this subscriber belongs to
ProMailerSubscriber::list_id	`int`
ProMailerSubscriber::num_bounce	`int`	Number of bounces for this subscriber
ProMailerSubscriber::num_sent	`int`	Number of messages sent to this subscriber
ProMailerSubscriber::page	`Page` `null`	Pages associated with subscriber if type is ProMailer::listTypePages
ProMailerSubscriber::type	`string`	Either ProMailer::listTypeRegular or ProMailer::listTypePages

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.251