$promailer API variable / ProMailer class

Bulk email distribution and subscriber management

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

Show $var?             Show args?        

Common

NameReturnSummary 
$promailer->defaultFromEmail string 
$promailer->defaultFromName string 
$promailer->defaultMailer string Default selected mailer 
$promailer->email ProMailerEmail 
$promailer->expireDays int 
$promailer->finished()
(nothing)Request maintenance 
$promailer->forceMailer string Force only this mailer 
$promailer->forms ProMailerForms 
$promailer->instance(string $name)
ProMailerTypeManager null arrayGet a helper instance 
$promailer->listUnsubDomains string 
$promailer->listUnsubEmail string 
$promailer->lists ProMailerLists 
$promailer->maintenance()
(nothing)Daily maintenance (called by ProcessProMailer) 
$promailer->maxBounce int 
$promailer->messages ProMailerMessages 
$promailer->ok()
boolModule status ok (Pro module verification) 
$promailer->queues ProMailerQueues 
$promailer->subscribers ProMailerSubscribers 
$promailer->transMailer string Mailer to use for transactional email (i.e. opt-in emails) 
$promailer->upgrade($fromVersion, $toVersion)
(nothing)Upgrade
$promailer->useGravatar string 
$promailer->useListUnsub int 
$promailer->useLogs array Logs to use 
$promailer->useTemplates array IDs of templates allowed for messages (empty=allow any) 
$promailer->useXMailer bool int Send an X-Mailer header in sent emails? 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani