Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
MassMail Class Reference
Inheritance diagram for MassMail:
MailTemplate Mail DataObject

Public Member Functions

 MassMail ($emailKey=null, $locale=null, $enableAttachments=null)
 send ()
 setCallback (&$callback)
 setFrequency ($frequency)
- Public Member Functions inherited from MailTemplate
 _clearAttachments ($userId)
 _handleAttachments ($userId)
 addPersistAttachment ($temporaryFile)
 assignParams ($paramArray=array())
 clearRecipients ($clearHeaders=true)
 displayEditForm ($formActionUrl, $hiddenFormParams=null, $alternateTemplate=null, $additionalParameters=array())
 getAddressFieldsEnabled ()
 hasErrors ()
 isEnabled ()
 MailTemplate ($emailKey=null, $locale=null, $enableAttachments=null, $context=null, $includeSignature=true)
processAddresses ($currentList, &$newAddresses)
 send ($clearAttachments=true)
 sendWithParams ($paramArray)
 setAddressFieldsEnabled ($addressFieldsEnabled)
- Public Member Functions inherited from Mail
 addAttachment ($filePath, $fileName= '', $contentType= '', $contentDisposition= 'attachment')
 addBcc ($email, $name= '')
 addCc ($email, $name= '')
 addHeader ($name, $content)
 addPrivateParam ($name, $value)
 addRecipient ($email, $name= '')
 clearAllRecipients ()
 encodeDisplayName ($displayName, $send=false)
 getAddressArrayString ($addresses, $includeNames=true, $send=false)
getAttachments ()
 getBccs ()
 getBccString ()
 getBody ()
 getCcs ()
 getCcString ()
 getContentType ()
 getEnvelopeSender ()
 getFrom ()
 getFromString ($send=false)
 getHeaders ()
 getRecipients ()
 getRecipientString ()
 getReplyTo ()
 getSubject ()
 hasAttachments ()
 Mail ()
 promoteCcsIfNoRecipients ()
 send ()
 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)
 DataObject ()
 extractMetadata ($metadataSchema)
 getAdditionalMetadataFieldNames ()
getAllData ()
getData ($key, $locale=null)
 getHasLoadableAdapters ()
 getId ()
 getLocaleMetadataFieldNames ()
getLocalizedData ($key)
 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)
 upcastTo ($targetObject)

Additional Inherited Members

- Public Attributes inherited from MailTemplate
- Public Attributes inherited from Mail
- Public Attributes inherited from DataObject
 $_data = array()
 $_extractionAdaptersLoaded = false
 $_hasLoadableAdapters = false
 $_injectionAdaptersLoaded = false
 $_metadataExtractionAdapters = array()
 $_metadataInjectionAdapters = array()

Detailed Description

Helper class to send mass emails.

Definition at line 19 of file

Member Function Documentation

MassMail::MassMail (   $emailKey = null,
  $locale = null,
  $enableAttachments = null 


Definition at line 26 of file

References MailTemplate\$emailKey, and MailTemplate\$locale.

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.


Definition at line 38 of file

MassMail::setFrequency (   $frequency)

Set the frequency at which the callback will be called (i.e. each n emails).

Definition at line 46 of file

The documentation for this class was generated from the following file: