MassMail Class Reference
[Mail]

Helper class to send mass emails. More...

Inheritance diagram for MassMail:

List of all members.

Public Member Functions
	MassMail ($emailKey=null, $locale=null, $enableAttachments=null, $journal=null)
	send ()
	setCallback (&$callback)
	setFrequency ($frequency)

---

Detailed Description

Helper class to send mass emails.

Definition at line 20 of file MassMail.inc.php.

---

Member Function Documentation

MassMail.MassMail	(	$	emailKey = null,
		$	locale = null,
		$	enableAttachments = null,
		$	journal = null
	)

Constructor

Definition at line 27 of file MassMail.inc.php.

MassMail.send

(

)

Send the email.

Returns:

boolean

Reimplemented from Mail.

Definition at line 55 of file MassMail.inc.php.

References Mail.clearAllRecipients(), and Mail.send().

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 39 of file MassMail.inc.php.

MassMail.setFrequency

(

$

frequency

)

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

Definition at line 47 of file MassMail.inc.php.

---

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

• classes/mail/MassMail.inc.php