EmailHandler Class Reference
[Pages_manager, Pages_user]
Handle requests for email management functions.
More...
Public Member Functions | |
| deleteCustomEmail ($args) | |
| disableEmail ($args) | |
| editEmail ($args=array()) | |
| email ($args) | |
| emails () | |
| enableEmail ($args) | |
| resetAllEmails () | |
| resetEmail ($args) | |
| updateEmail () | |
Detailed Description
Handle requests for email management functions.Handle requests for user emails.
Definition at line 18 of file EmailHandler.inc.php.
Member Function Documentation
| EmailHandler.deleteCustomEmail | ( | $ | args | ) |
Delete a custom email.
- Parameters:
-
$args array first parameter is the key of the email to delete
Reimplemented from ManagerHandler.
Definition at line 96 of file EmailHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), and Request.redirect().
| EmailHandler.disableEmail | ( | $ | args | ) |
disables an email template.
- Parameters:
-
$args array first parameter is the key of the email to disable
Reimplemented from ManagerHandler.
Definition at line 143 of file EmailHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), and Request.redirect().
| EmailHandler.editEmail | ( | $ | args = array() |
) |
Display form to create/edit an email.
- Parameters:
-
$args array optional, if set the first parameter is the key of the email template to edit
Reimplemented from ManagerHandler.
Definition at line 53 of file EmailHandler.inc.php.
References TemplateManager.getManager(), and Request.url().
| EmailHandler.email | ( | $ | args | ) |
Send an email to a user or group of users.
Reimplemented from ManagerHandler.
Definition at line 19 of file EmailHandler.inc.php.
References Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.getUser(), Request.getUserVar(), Config.getVar(), Validation.isEditor(), Validation.isJournalManager(), Validation.isSectionEditor(), Validation.isSiteAdmin(), Request.redirectUrl(), and Request.url().
| EmailHandler.emails | ( | ) |
Display a list of the emails within the current journal.
Definition at line 23 of file EmailHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), Locale.getLocale(), TemplateManager.getManager(), Handler.getRangeInfo(), and Request.url().
| EmailHandler.enableEmail | ( | $ | args | ) |
enables an email template.
- Parameters:
-
$args array first parameter is the key of the email to enable
Reimplemented from ManagerHandler.
Definition at line 176 of file EmailHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), and Request.redirect().
| EmailHandler.resetAllEmails | ( | ) |
resets all email templates associated with the journal.
Reimplemented from ManagerHandler.
Definition at line 129 of file EmailHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), and Request.redirect().
| EmailHandler.resetEmail | ( | $ | args | ) |
Reset an email to default.
- Parameters:
-
$args array first parameter is the key of the email to reset
Reimplemented from ManagerHandler.
Definition at line 113 of file EmailHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), and Request.redirect().
| EmailHandler.updateEmail | ( | ) |
Save changes to an email.
Reimplemented from ManagerHandler.
Definition at line 72 of file EmailHandler.inc.php.
References Request.getUserVar(), Request.redirect(), and ManagerHandler.validate().
The documentation for this class was generated from the following files:
- pages/manager/EmailHandler.inc.php
- pages/user/EmailHandler.inc.php
