ProMailerSubscriber class

ProMailer Subscriber

Copyright 2023 by Ryan Cramer

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.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
ProMailerSubscriber::allowResend()
bool

Allow re-send of confirmation email?

 
ProMailerSubscriber::confData()
array bool int string

Get or set confirmation email data


Can also be used as property: ProMailerSubscriber::confData 		 
ProMailerSubscriber::custom()
bool int mixed null string

Get or set custom field values


Can also be used as property: ProMailerSubscriber::custom 		 
ProMailerSubscriber::get($key)
None 
ProMailerSubscriber::getConfData()
array int string

Get all confirmation email data

 
ProMailerSubscriber::getCustom()
string int mixed bool null

Get custom field value

 
ProMailerSubscriber::getDefaultsArray()
None 
ProMailerSubscriber::getList()
ProMailerList null

Get the list this subscriber belongs to

 
ProMailerSubscriber::gravatar()
string

Get gravatar <img> tag for subscriber

 
ProMailerSubscriber::saveCustom()
bool

Save custom field data now

 
ProMailerSubscriber::set($key, $value)
None 
ProMailerSubscriber::setConfData(array $confData)
bool

Set confirmation email data

 
ProMailerSubscriber::setCustom(string $name, mixed $value)
bool

Set value for custom field while also sanitizing it

 
ProMailerSubscriber::setList(ProMailerList $list)
$this

Set the list for this subscriber

 

Properties

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::email string 
ProMailerSubscriber::flags int 
ProMailerSubscriber::id int 
ProMailerSubscriber::list ProMailerList null List that this subscriber belongs to 
ProMailerSubscriber::list_id int 
ProMailerSubscriber::manager ProMailerSubscribers 
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.255