ProMailerList class

ProMailer subscriber list

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

Common
Properties

Common

Name	Return	Summary
ProMailerList::fieldsArray() ProMailerList::fieldsArray() ProMailerList::fieldsArray()	`array`	Return array of custom field definitions for this list
ProMailerList::fieldsString() ProMailerList::fieldsString() ProMailerList::fieldsString()	`string`	Get newline separated string of custom field definitions for this list
ProMailerList::getDefaultsArray() ProMailerList::getDefaultsArray() ProMailerList::getDefaultsArray()	None
ProMailerList::numSubscribers() ProMailerList::numSubscribers() ProMailerList::numSubscribers(bool $confirmed = false)	`int`	Return number of subscribers in this list
ProMailerList::set() ProMailerList::set($key, $value) ProMailerList::set($key, $value)	None

Properties

Name	Return	Summary
ProMailerList::closed	`bool`	List closed for new subscribers? only used by regular lists
ProMailerList::custom	`array`	Additional custom data to store with this list in associative array
ProMailerList::fields	`array`	Custom field definitions as ['name' => 'sanitizer'], only used by regular lists
ProMailerList::id	`int`
ProMailerList::manager	`ProMailerLists`
ProMailerList::selector	`string`	Selector string, only used by pages lists
ProMailerList::title	`string`
ProMailerList::type	`string`	Either ProMailer::listTypeRegular or ProMailer::listTypePages
ProMailerList::unsub_email	`string`	Email address for optional list-unsubscribe header
ProMailerList::unsub_field	`string`	Field name that has non-empty value if user is unsubscribed, only used by pages lists

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.251