actions_email Class Reference

Public Member Functions
	handle (&$params)
	isBlackListed ($email)
	getBlackListed ($emails)
	createEmailTables ($tablename, $join_table)
	_replaceFieldCallback ($matches)
	Called on matches of field macros. $matches[0] e.g. {$fieldname} $matches[1] e.g. fieldname.
	getAttachments ($emailId)
	sendMail ($emailId, $emailTable=null, $joinTable=null, $recipientsTable=null, $emailColumn=null)
	postJob ($emailId, $emailTable=null, $joinTable=null, $recipientsTable=null, $emailColumn=null)
Data Fields
	$messages = array()
	$emailTable
	$joinTable
	$recipientsTable
	$emailColumn

---

Detailed Description

This action sends email to the current found set. It provides the user with an email form where they can type a subject and a body. They can include macro variables that will be parsed for each record so that each email can be customized to an extent.

Author:

Steve Hannah <steve@weblite.ca> August 2007 January 2012 To use new table structures (by Steve Hannah)

Definition at line 33 of file email.php.

---

Member Function Documentation

_replaceFieldCallback

(

$

matches

)

Called on matches of field macros. $matches[0] e.g. {$fieldname} $matches[1] e.g. fieldname.

Definition at line 277 of file email.php.

createEmailTables	(	$	tablename,
		$	join_table
	)

Creates the email tables necessary to store the email.

Parameters:

$tablename	The name of the table that is to store the email messages themselves.
$join_table	The name of the table that stores the status of each sent email.

Returns:

void

Definition at line 221 of file email.php.

getAttachments

(

$

emailId

)

Definition at line 283 of file email.php.

getBlackListed

(

$

emails

)

Definition at line 202 of file email.php.

handle

(

&$

params

)

implements action handle() method.

Definition at line 44 of file email.php.

isBlackListed

(

$

email

)

Definition at line 193 of file email.php.

postJob	(	$	emailId,
		$	emailTable = null,
		$	joinTable = null,
		$	recipientsTable = null,
		$	emailColumn = null
	)

Definition at line 533 of file email.php.

sendMail	(	$	emailId,
		$	emailTable = null,
		$	joinTable = null,
		$	recipientsTable = null,
		$	emailColumn = null
	)

Sends the email specified by $emailId to all recipients.

Parameters:

integer	$emailId	The id of the email message.
string	$emailTable	Optional the name of the table containing the email messages.
string	$joinTable	Optional the name of the table corresponding to a single recipient of the given email.
string	$recipientsTable	The name of the table where the recipients originated from.
string	$emailColumn	The name of the column that stored the email address.

Definition at line 325 of file email.php.

---

Field Documentation

$emailColumn

Definition at line 39 of file email.php.

$emailTable

Definition at line 36 of file email.php.

$joinTable

Definition at line 37 of file email.php.

$messages = array()

Definition at line 35 of file email.php.

$recipientsTable

Definition at line 38 of file email.php.

---

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

• actions/email.php