$promailer
Copyright 2023 by Ryan Cramer
This is a commercial module, do not distribute.
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.
Common
| Name | Return | Summary | |
|---|---|---|---|
$promailer->finished() $promailer->finished() $promailer->finished(HookEvent $event = null) | None | Request maintenance | |
$promailer->instance() $promailer->instance(string $name) $promailer->instance(string $name) | ProMailerTypeManager null array | Get a helper instance | |
$promailer->maintenance() $promailer->maintenance() $promailer->maintenance() | None | Daily maintenance (called by ProcessProMailer) | |
$promailer->ok() $promailer->ok() $promailer->ok() | bool | Module status ok (Pro module verification) | |
$promailer->upgrade() $promailer->upgrade($fromVersion, $toVersion) $promailer->upgrade($fromVersion, $toVersion) | None | Upgrade |
Properties
| Name | Return | Summary | |
|---|---|---|---|
| $promailer->defaultFromEmail | string | ||
| $promailer->defaultFromName | string | ||
| $promailer->defaultMailer | string | Default selected mailer | |
| $promailer->email | ProMailerEmail | ||
| $promailer->expireDays | int | ||
| $promailer->forceMailer | string | Force only this mailer | |
| $promailer->forms | ProMailerForms | ||
| $promailer->listUnsubDomains | string | ||
| $promailer->listUnsubEmail | string | ||
| $promailer->lists | ProMailerLists | ||
| $promailer->maxBounce | int | ||
| $promailer->messages | ProMailerMessages | ||
| $promailer->processGetVar | string | GET var required presence to process background queue v12+ DEFAULT: '' | |
| $promailer->queues | ProMailerQueues | ||
| $promailer->subscribers | ProMailerSubscribers | ||
| $promailer->transMailer | string | Mailer to use for transactional email (i.e. opt-in emails) | |
| $promailer->unsubDelete | bool int | Delete subscribers when they unsubscribe? NOT YET IMPLEMENTED DEFAULT: true | |
| $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.255