ProMailerList class

Located in file /site/modules/ProMailer/ProMailerList.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 ProMailerList class also inherits all the methods and properties of: ProMailerType, WireData and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
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::fieldsArray()
arrayReturn array of custom field definitions for this list 
ProMailerList::fieldsString()
stringGet newline separated string of custom field definitions for this list 
ProMailerList::getDefaultsArray()
arrayReturn array of default values 
ProMailerList::id int 
ProMailerList::manager ProMailerLists 
ProMailerList::numSubscribers()
intReturn number of subscribers in this list 
ProMailerList::selector string Selector string, only used by pages lists 
ProMailerList::set($key, $value)
WireData ProMailerTypeSet value 
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.236

Newest forum posts

Latest news

  • ProcessWire Weekly #553
    In the 553rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module called Text Synthesis, and more. Read on!
    Weekly.pw / 14 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright” —Marc Hinse, Web designer/developer