PHP Class Pommo_Mailer, poMMo

Inheritance: extends PHPMailer
Show file Open project: soonick/poMMo Class Usage Examples

Public Properties

Property Type Description
$_altbody
$_attachments
$_body
$_charset
$_demonstration counter for mails sent sucessfully.
$_exchanger
$_frombounce
$_fromemail
$_fromname
$_personalize
$_sentCount .. currently mail or sendmail are used TODO add smtp
$_subject
$_validated
$logger . this is used for bulk mailing

Public Methods

Method Description
GetMessageSize ( ) returns the size (in bytes) of the last sent message
Pommo_Mailer ( $fromname = NULL, $fromemail = NULL, $frombounce = NULL, $exchanger = NULL, $demonstration = NULL, $charset = NULL, $personalize = FALSE ) If an argument is not supplied, resorts to default value (from setup/config.php).
bmSendmail ( &$to, $subscriber = FALSE ) * bmSendmail ** SEND MAIL FUNCTION --> pass an array of senders, or a single email address for single mode TODO rename function send in order to not confuse w/ PHPMailer's Send()?
prepareMail ( $subject = NULL, $body = NULL, $HTML = FALSE, $altbody = NULL, $attachments = NULL ) * prepareMail Sets up the mail message.
setRelay ( &$smtp ) sets the SMTP relay for this mailer
toggleDemoMode ( $val = NULL ) toggles demonstration mode on or off if sepcified, or else uses the configured mode. Returns value.
trackMessageSize ( $bool = TRUE ) enable to track size (in bytes) of sent messages.
validate ( ) Gets called before sending a mail to make sure all is proper (during prepareMail). Returns false if messages were created must pass global poMMo object (TODO maybe rename to site??)

Method Details

GetMessageSize() public method

returns the size (in bytes) of the last sent message
public GetMessageSize ( )

Pommo_Mailer() public method

If an argument is not supplied, resorts to default value (from setup/config.php).
public Pommo_Mailer ( $fromname = NULL, $fromemail = NULL, $frombounce = NULL, $exchanger = NULL, $demonstration = NULL, $charset = NULL, $personalize = FALSE )

bmSendmail() public method

* bmSendmail ** SEND MAIL FUNCTION --> pass an array of senders, or a single email address for single mode TODO rename function send in order to not confuse w/ PHPMailer's Send()?
public bmSendmail ( &$to, $subscriber = FALSE )
$subscriber

prepareMail() public method

* prepareMail Sets up the mail message.
public prepareMail ( $subject = NULL, $body = NULL, $HTML = FALSE, $altbody = NULL, $attachments = NULL )
$subject
$body
$altbody
$attachments

setRelay() public method

sets the SMTP relay for this mailer
public setRelay ( &$smtp )

toggleDemoMode() public method

toggles demonstration mode on or off if sepcified, or else uses the configured mode. Returns value.
public toggleDemoMode ( $val = NULL )

trackMessageSize() public method

enable to track size (in bytes) of sent messages.
public trackMessageSize ( $bool = TRUE )

validate() public method

Gets called before sending a mail to make sure all is proper (during prepareMail). Returns false if messages were created must pass global poMMo object (TODO maybe rename to site??)
public validate ( )

Property Details

$_altbody public property

public $_altbody

$_attachments public property

public $_attachments

$_body public property

public $_body

$_charset public property

public $_charset

$_demonstration public property

counter for mails sent sucessfully.
public $_demonstration

$_exchanger public property

public $_exchanger

$_frombounce public property

public $_frombounce

$_fromemail public property

public $_fromemail

$_fromname public property

public $_fromname

$_personalize public property

public $_personalize

$_sentCount public property

.. currently mail or sendmail are used TODO add smtp
public $_sentCount

$_subject public property

public $_subject

$_validated public property

public $_validated

$logger public property

. this is used for bulk mailing
public $logger