MailTemplate Class Reference
[Plugins_generic_translator]

Subclass of PKPMailTemplate for mailing a template email. More...

Inheritance diagram for MailTemplate:

List of all members.

Public Member Functions
	assignParams ($paramArray=array())
	displayEditForm ($formActionUrl, $hiddenFormParams=null, $alternateTemplate=null, $additionalParameters=array())
	MailTemplate ($emailKey=null, $locale=null, $enableAttachments=null, $conference=null, $schedConf=null, $includeSignature=true, $ignorePostedData=false)
	send ($clearAttachments=true)
Public Attributes
	$conference

---

Detailed Description

Subclass of PKPMailTemplate for mailing a template email.

Definition at line 18 of file MailTemplate.inc.php.

---

Member Function Documentation

MailTemplate.assignParams

(

$

paramArray = array()

)

Assigns values to e-mail parameters.

Parameters:

$paramArray

array

Returns:

void

Reimplemented in PaperMailTemplate.

Definition at line 114 of file MailTemplate.inc.php.

References $conference, Request.getConference(), Request.getRequestedConferencePath(), Request.getRequestedSchedConfPath(), Request.getSchedConf(), and Request.url().

MailTemplate.displayEditForm	(	$	formActionUrl,
		$	hiddenFormParams = null,
		$	alternateTemplate = null,
		$	additionalParameters = array()
	)

Displays an edit form to customize the email.

Parameters:

	$formActionUrl	string
	$hiddenFormParams	array

Returns:

void

Definition at line 143 of file MailTemplate.inc.php.

MailTemplate.MailTemplate	(	$	emailKey = null,
		$	locale = null,
		$	enableAttachments = null,
		$	conference = null,
		$	schedConf = null,
		$	includeSignature = true,
		$	ignorePostedData = false
	)

Constructor.

Parameters:

	$emailKey	string unique identifier for the template
	$locale	string locale of the template
	$enableAttachments	boolean optional Whether or not to enable paper attachments in the template
	$conference	object optional The conference this message relates to
	$schedConf	object optional The scheduled conference this message relates to
	$includeSignature	boolean optional
	$ignorePostedData	boolean optional

Definition at line 32 of file MailTemplate.inc.php.

References $conference, Request.getConference(), Request.getSchedConf(), and send().

MailTemplate.send

(

$

clearAttachments = true

)

Send the email. Aside from calling the parent method, this actually attaches the persistent attachments if they are used.

Parameters:

$clearAttachments

boolean Whether to delete attachments after

Definition at line 156 of file MailTemplate.inc.php.

References Request.getSchedConf().

Referenced by MailTemplate().

---

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

• classes/mail/MailTemplate.inc.php

---