ProMailerSubscriber class

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

Show class?             Show args?        

Common

NameReturnSummary 
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::get($key)
mixed nullRetrieve the value for a previously set property, or retrieve an API variable 
ProMailerSubscriber::getCustom($name)
(nothing) 
ProMailerSubscriber::getDefaultsArray()
arrayReturn array of default values 
ProMailerSubscriber::getList()
ProMailerList nullGet the list this subscriber belongs to 
ProMailerSubscriber::gravatar()
(nothing) 
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::set($key, $value)
WireData ProMailerTypeSet value 
ProMailerSubscriber::setCustom(string $name, mixed $value)
boolSet value for custom field while also sanitizing it 
ProMailerSubscriber::setList(ProMailerList $list)
$thisSet the list for this subscriber 
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.236

Newest forum posts

Latest news

  • ProcessWire Weekly #556
    In the 556th issue of ProcessWire Weekly we're going to share the latest core development news, highlight a new third party module, and more. Read on!
    Weekly.pw / 4 January 2025
  • 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

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH