BeforeEmail: Difference between revisions
From LimeSurvey Manual
DenisChenu (talk | contribs) (Page creation with current input and output) |
DenisChenu (talk | contribs) (See also) |
||
(5 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{FeatureStarting|4.0.0}} | {{FeatureStarting|4.0.0}} | ||
'''Usage''' | '''Usage''' | ||
Line 12: | Line 9: | ||
The event receives the following information: | The event receives the following information: | ||
* mailer : The mailer object | * mailer : The mailer object | ||
* type : Email type : | * type : Email type : 'passwordreminderadminuser', 'addadminuser', 'mailsendusergroup'. default is unknow, and deprecated usage of function is 'deprecated' | ||
* subject : Email subject | * subject : Email subject | ||
* to : Recipient(s) with format <code>[email,name]</code> | * to : Recipient(s) with format <code><nowiki>[email,name]</nowiki></code> | ||
* body : Email body content | * body : Email body content | ||
* from : Sender (From) | * from : Sender (From) | ||
Line 28: | Line 25: | ||
* subject : Email subject | * subject : Email subject | ||
* body : Email body content | * body : Email body content | ||
* to : Recipient(s) in <code>[[email,name]]</code> format | * to : Recipient(s) in <code><nowiki>[[email,name]]</nowiki></code> format | ||
* from : From email and name | * from : From email and name | ||
* bounce : Return-Path | * bounce : Return-Path | ||
Line 34: | Line 31: | ||
* message : If send is true and action return a message : the message to be shown | * message : If send is true and action return a message : the message to be shown | ||
* error : If set and "send" is true, log the error as failed email attempt. | * error : If set and "send" is true, log the error as failed email attempt. | ||
'''Usage of mailer''' | |||
The plugin offer as input the mailer object, then you can access and set mailer variables. For example to get the Body before you can use rawBody variables. Since mailer have a public function to do own replacement, you can update the raw body and do the replacement after. | |||
A sample code can be : | |||
<syntaxhighlight lang="php"> | |||
$mailer = $this->getEvent()->get(mailer); | |||
$rawBody = $mailer->rawBody; | |||
// Clean up code | |||
$oPurifier = new \CHtmlPurifier(); | |||
$rawBody = $oPurifier->purify($rawBody); | |||
$body = $mailer->doReplacements($rawBody); | |||
$this->getEvent()->set('body',$body); | |||
</syntaxhighlight> | |||
Check '''mailSenderToFrom''' core plugin for another usage of mailer to set the sender, the Response-To and the From-To. The whole class are [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/core/LimeMailer.php LimeMailer] and extend [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/third_party/phpmailer/src/PHPMailer.php PHPMailer]. | |||
'''Example''' | '''Example''' | ||
Line 39: | Line 54: | ||
* [https://gitlab.com/SondagesPro/mailing/noMailToExample noMailToExample] | * [https://gitlab.com/SondagesPro/mailing/noMailToExample noMailToExample] | ||
* [https://github.com/LimeSurvey/LimeSurvey/blob/develop/plugins/mailSenderToFrom/mailSenderToFrom.php mailSenderToFrom] | * [https://github.com/LimeSurvey/LimeSurvey/blob/develop/plugins/mailSenderToFrom/mailSenderToFrom.php mailSenderToFrom] | ||
'''See also''' | |||
* [[beforeSurveyEmail]] | |||
* [[beforeTokenEmail]] | |||
[[Category:Plugins events]] | [[Category:Plugins events]] |
Revision as of 12:20, 20 April 2020
Hint: This features is available starting in version 4.0.0
Usage
This event can be used each time an email not related to a survey is send.
Input
The event receives the following information:
- mailer : The mailer object
- type : Email type : 'passwordreminderadminuser', 'addadminuser', 'mailsendusergroup'. default is unknow, and deprecated usage of function is 'deprecated'
- subject : Email subject
- to : Recipient(s) with format
[email,name]
- body : Email body content
- from : Sender (From)
- bounce : The Sender (Return-Path)
- survey : null
- model : null
- updateDisable : array
Possible output
The following information can be set in the event:
- updateDisable : if plugin use mailer to update other parts, allow to disable update by default action
- subject : Email subject
- body : Email body content
- to : Recipient(s) in
[[email,name]]
format - from : From email and name
- bounce : Return-Path
- send : If true Limesurvey will send the email. Setting this to false will cause Limesurvey to assume the mail has been sent by the plugin.
- message : If send is true and action return a message : the message to be shown
- error : If set and "send" is true, log the error as failed email attempt.
Usage of mailer
The plugin offer as input the mailer object, then you can access and set mailer variables. For example to get the Body before you can use rawBody variables. Since mailer have a public function to do own replacement, you can update the raw body and do the replacement after.
A sample code can be :
$mailer = $this->getEvent()->get(mailer);
$rawBody = $mailer->rawBody;
// Clean up code
$oPurifier = new \CHtmlPurifier();
$rawBody = $oPurifier->purify($rawBody);
$body = $mailer->doReplacements($rawBody);
$this->getEvent()->set('body',$body);
Check mailSenderToFrom core plugin for another usage of mailer to set the sender, the Response-To and the From-To. The whole class are LimeMailer and extend PHPMailer.
Example
See also