Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes

emailService Class Reference

Inheritance diagram for emailService:
Inheritance graph
[legend]
Collaboration diagram for emailService:
Collaboration graph
[legend]

Public Member Functions

 __construct (&$xmlArr)
 getErrorMsg ()
 useAccount ($accountName)
 sendEmail ($TOs=null, $CCs=null, $BCCs=null, $subject, $body, $attachments=null, $isHTML=false)
 logEmail ($result, $subject, $body=NULL, $TOs=NULL, $CCs=NULL, $BCCs=NULL)

Data Fields

 $m_Accounts = null

Protected Member Functions

 readMetadata (&$xmlArr)

Protected Attributes

 $m_UseAccount

Detailed Description

Definition at line 29 of file emailService.php.


Constructor & Destructor Documentation

__construct ( &$  xmlArr )

Initialize emailService with xml array metadata

Parameters:
array$xmlArr
Returns:
void

Reimplemented from MetaObject.

Definition at line 87 of file emailService.php.

Here is the call graph for this function:


Member Function Documentation

getErrorMsg (  )

Get error message

Returns:
string

Definition at line 120 of file emailService.php.

logEmail ( result,
subject,
body = NULL,
TOs = NULL,
CCs = NULL,
BCCs = NULL 
)

Log that an email attemp was made. We assume it was successfull, since Zend_Mail throws an exception otherwise

Parameters:
string$subject
array$To
array$CCs
array$BCCs
Returns:
mixed boolean|string|void

Definition at line 275 of file emailService.php.

Here is the call graph for this function:

Here is the caller graph for this function:

readMetadata ( &$  xmlArr ) [protected]

Read array meta-data, and store to meta-object

Parameters:
array$xmlArr
Returns:
void

Reimplemented from MetaObject.

Definition at line 103 of file emailService.php.

Here is the caller graph for this function:

sendEmail ( TOs = null,
CCs = null,
BCCs = null,
subject,
body,
attachments = null,
isHTML = false 
)

A convenience function that will issue an email based on the parameter provided Will log email attempts but will NOT run the body through a template

Parameters:
array$TOs
array$CCs
array$BCCs
array$subject
array$body
array$attachments
boolean$isHTML
Returns:
boolean $result - TRUE on success, FALSE on failure

Definition at line 188 of file emailService.php.

Here is the call graph for this function:

useAccount ( accountName )

Will set the Default Transport object for the mail object based on the supplied accountname

Parameters:
string$accountName
Returns:
boolean TRUE/FALSE

Definition at line 142 of file emailService.php.

Here is the caller graph for this function:


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