Public Member Functions

MailTemplate Class Reference

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

Inheritance diagram for MailTemplate:
MonographMailTemplate

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, $press=null, $includeSignature=true)
 send ($clearAttachments=true)

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 MonographMailTemplate.

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

References Request.getRequestedPressPath(), 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 136 of file MailTemplate.inc.php.

MailTemplate.MailTemplate ( $  emailKey = null,
$  locale = null,
$  enableAttachments = null,
$  press = null,
$  includeSignature = true 
)

Constructor.

Parameters:
$emailKey string unique identifier for the template
$locale string locale of the template
$enableAttachments boolean optional Whether or not to enable monograph attachments in the template
$press object optional The press this message relates to
$includeSignature boolean optional Whether or not to include the Press signature

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

References Request.getPress().

Referenced by MonographMailTemplate.MonographMailTemplate().

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

Reimplemented in MonographMailTemplate.

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

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:57 for Open Monograph Press by  doxygen 1.7.1