Public Member Functions | |
| __construct ($emailKey=null, $locale=null) | |
| send () | |
| setCallback (&$callback) | |
| setFrequency ($frequency) | |
 Public Member Functions inherited from MailTemplate | |
| __construct ($emailKey=null, $locale=null, $context=null, $includeSignature=true) | |
| assignParams ($params=array()) | |
| clearRecipients ($clearHeaders=true) | |
| getAddressFieldsEnabled () | |
| hasErrors () | |
| isEnabled () | |
| manageURLValues ($targetString, $key, $value) | |
| replaceParams () | |
| sendWithParams ($params) | |
| setAddressFieldsEnabled ($addressFieldsEnabled) | |
| Public Member Functions inherited from Mail | |
| __construct () | |
| addAttachment ($filePath, $fileName='', $contentType='', $contentDisposition='attachment') | |
| addBcc ($email, $name='') | |
| addCc ($email, $name='') | |
| addHeader ($name, $content) | |
| addPrivateParam ($name, $value) | |
| addRecipient ($email, $name='') | |
| addReplyTo ($email, $name='') | |
| clearAllRecipients () | |
| getAddressArrayString ($addresses, $includeNames=true, $send=false) | |
| & | getAttachments () |
| getBccs () | |
| getBccString () | |
| getBody () | |
| getCcs () | |
| getCcString () | |
| getContentType () | |
| getEnvelopeSender () | |
| getFrom () | |
| getFromString ($send=false) | |
| getHeaders () | |
| getRecipients () | |
| getRecipientString () | |
| getReplyTo () | |
| getReplyToString ($send=false) | |
| getSubject () | |
| hasAttachments () | |
| promoteCcsIfNoRecipients () | |
| setBccs ($bccs) | |
| setBody ($body) | |
| setCcs ($ccs) | |
| setContentType ($contentType) | |
| setEnvelopeSender ($envelopeSender) | |
| setFrom ($email, $name='') | |
| setHeaders (&$headers) | |
| setPrivateParams ($privateParams) | |
| setRecipients ($recipients) | |
| setReplyTo ($email, $name='') | |
| setSubject ($subject) | |
| Public Member Functions inherited from DataObject | |
| addSupportedMetadataAdapter ($metadataAdapter) | |
| extractMetadata ($metadataSchema) | |
| getAdditionalMetadataFieldNames () | |
| & | getAllData () |
| getDAO () | |
| & | getData ($key, $locale=null) |
| getHasLoadableAdapters () | |
| getId () | |
| getLocaleMetadataFieldNames () | |
| getLocalizedData ($key, $preferredLocale=null) | |
| getMetadataFieldNames ($translated=true) | |
| getSetMetadataFieldNames ($translated=true) | |
| getSupportedExtractionAdapters () | |
| getSupportedInjectionAdapters () | |
| getSupportedMetadataSchemas () | |
| hasData ($key, $locale=null) | |
| injectMetadata ($metadataDescription) | |
| removeSupportedMetadataAdapter ($metadataSchemaName) | |
| setAllData (&$data) | |
| setData ($key, $value, $locale=null) | |
| setHasLoadableAdapters ($hasLoadableAdapters) | |
| setId ($id) | |
| unsetData ($key, $locale=null) | |
| upcastTo ($targetObject) | |
Data Fields | |
| $callback | |
| $frequency | |
| Data Fields inherited from MailTemplate | |
| $addressFieldsEnabled | |
| $bccSender | |
| $context | |
| $emailKey | |
| $enabled | |
| $errorMessages | |
| $includeSignature | |
| $locale | |
| $params | |
| Data Fields inherited from Mail | |
| $privateParams | |
| Data Fields inherited from DataObject | |
| $_data = array() | |
| $_extractionAdaptersLoaded = false | |
| $_hasLoadableAdapters = false | |
| $_injectionAdaptersLoaded = false | |
| $_metadataExtractionAdapters = array() | |
| $_metadataInjectionAdapters = array() | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Mail | |
| static | encodeDisplayName ($displayName, $send=false) |
Detailed Description
Helper class to send mass emails.
Definition at line 19 of file MassMail.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| MassMail::__construct | ( | $emailKey = null, |
|
$locale = null |
|||
| ) |
Constructor
Definition at line 26 of file MassMail.inc.php.
References MailTemplate\$emailKey, and MailTemplate\$locale.
Member Function Documentation
◆ send()
| MassMail::send | ( | ) |
Send the email.
- Returns
- boolean
Reimplemented from MailTemplate.
Definition at line 54 of file MassMail.inc.php.
References Mail\addRecipient(), Mail\clearAllRecipients(), Mail\getBody(), Mail\getRecipients(), Mail\getSubject(), MailTemplate\send(), Mail\setBody(), Mail\setRecipients(), and Mail\setSubject().
◆ setCallback()
| MassMail::setCallback | ( | & | $callback | ) |
Set the callback function (see PHP's callback pseudotype); this function will be called for every n emails sent, according to the frequency.
- Parameters
-
$callback callback
Definition at line 38 of file MassMail.inc.php.
References $callback.
◆ setFrequency()
| MassMail::setFrequency | ( | $frequency | ) |
Set the frequency at which the callback will be called (i.e. each n emails).
Definition at line 46 of file MassMail.inc.php.
References $frequency.
Field Documentation
◆ $callback
| MassMail::$callback |
Definition at line 20 of file MassMail.inc.php.
Referenced by setCallback().
◆ $frequency
| MassMail::$frequency |
Definition at line 21 of file MassMail.inc.php.
Referenced by setFrequency().
The documentation for this class was generated from the following file:
