ArticleMailTemplate Class Reference
[Mail]

Subclass of MailTemplate for sending emails related to articles. More...

Inheritance diagram for ArticleMailTemplate:

List of all members.

Public Member Functions
	ArticleMailTemplate ($article, $emailKey=null, $locale=null, $enableAttachments=null, $journal=null)
	assignParams ($paramArray=array())
	log ()
	send ()
	sendWithParams ($paramArray)
	setAssoc ($eventType, $assocType, $assocId)
	setJournal ($journal)

---

Detailed Description

Subclass of MailTemplate for sending emails related to articles.

This allows for article-specific functionality like logging, etc.

Definition at line 23 of file ArticleMailTemplate.inc.php.

---

Member Function Documentation

ArticleMailTemplate.ArticleMailTemplate	(	$	article,
		$	emailKey = null,
		$	locale = null,
		$	enableAttachments = null,
		$	journal = null
	)

Constructor.

Parameters:

	$article	object
	$emailType	int optional
	$locale	string optional
	$enableAttachments	boolean optional
	$journal	object optional

See also:

MailTemplate.MailTemplate()

Definition at line 49 of file ArticleMailTemplate.inc.php.

ArticleMailTemplate.assignParams

(

$

paramArray = array()

)

Assigns values to e-mail parameters.

Parameters:

$paramArray

array

Returns:

void

Reimplemented from MailTemplate.

Definition at line 54 of file ArticleMailTemplate.inc.php.

References Request.getJournal().

Referenced by sendWithParams().

ArticleMailTemplate.log

(

)

Save the email in the article email log.

Definition at line 123 of file ArticleMailTemplate.inc.php.

References Mail.getBccString(), Mail.getCcString(), Mail.getFromString(), Mail.getRecipientString(), and ArticleLog.logEmailEntry().

Referenced by send().

ArticleMailTemplate.send

(

)

See also:

parent.send()

Reimplemented from Mail.

Definition at line 71 of file ArticleMailTemplate.inc.php.

References MailTemplate._clearAttachments(), Request.getUser(), and log().

Referenced by sendWithParams().

ArticleMailTemplate.sendWithParams

(

$

paramArray

)

See also:

parent.sendWithParams()

Reimplemented from MailTemplate.

Definition at line 86 of file ArticleMailTemplate.inc.php.

References assignParams(), and send().

ArticleMailTemplate.setAssoc	(	$	eventType,
		$	assocType,
		$	assocId
	)

Add a generic association between this email and some event type / type / ID tuple.

Parameters:

	$eventType	int
	$assocType	int
	$assocId	int

Definition at line 106 of file ArticleMailTemplate.inc.php.

ArticleMailTemplate.setJournal

(

$

journal

)

Set the journal this message is associated with.

Parameters:

$journal

object

Definition at line 116 of file ArticleMailTemplate.inc.php.

---

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

• classes/mail/ArticleMailTemplate.inc.php