ProMailerLists class

Copyright 2019 by Ryan Cramer

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

Common

Name	Return	Summary
ProMailerLists::add() ProMailerLists::add(string $title) ProMailerLists::add(string $title, string $type = '')	`int`	Add a new list with given title and return the ID for it
ProMailerLists::get() ProMailerLists::get(int $listId) ProMailerLists::get(int $listId)	`ProMailerList` `bool`	Get ProMailerList for given list ID or boolean false if not found
ProMailerLists::getAll() ProMailerLists::getAll() ProMailerLists::getAll(int $listId = 0)	`ProMailerList`	Get all lists in an array
ProMailerLists::getOpen() ProMailerLists::getOpen() ProMailerLists::getOpen($first = false)	`ProMailerList`	Return array of all lists open for subscription
ProMailerLists::install() ProMailerLists::install() ProMailerLists::install()	None
ProMailerLists::remove() ProMailerLists::remove(ProMailerList $list) ProMailerLists::remove(ProMailerList $list)	`bool`	Remove list and all subscribers in it
ProMailerLists::save() ProMailerLists::save(ProMailerList $list) ProMailerLists::save(ProMailerList $list)	`bool`	Save the given list
ProMailerLists::saveSent() ProMailerLists::saveSent($list) ProMailerLists::saveSent($list, int $lastSent = 0)	`bool`	Update last sent date of list
ProMailerLists::table() ProMailerLists::table() ProMailerLists::table()	None
ProMailerLists::upgrade() ProMailerLists::upgrade($fromVersion, $toVersion) ProMailerLists::upgrade($fromVersion, $toVersion)	None

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.251