BeforeTokenEmail: Difference between revisions
From LimeSurvey Manual
DenisChenu (talk | contribs) mNo edit summary |
DenisChenu (talk | contribs) (Update for (2.51.5 ?) https://github.com/LimeSurvey/LimeSurvey/commit/4befbe5961db2db9b9f190a2e4284f670ece8f84) |
||
| Line 8: | Line 8: | ||
The event receives the following information: | The event receives the following information: | ||
* type : Email type(remind, invite or register{{NewIn|v=2. | * type : Email type (reminder, invitation, confirm or register {{NewIn|v=2.06}}) | ||
* model : model used in survey_languagesettings table (remind, invite, confirm or register {{NewIn|v=2.51.5}}) | |||
* survey : The survey id {{NewIn|v=2.51.5}}) | |||
* subject : Email subject | * subject : Email subject | ||
* to : Recipient(s) | * to : Recipient(s) | ||
* body : Email body content | * body : Email body content | ||
* from : Sender(s) | * from : Sender(s) | ||
* token : Raw token data | * token : Raw token data in an array . | ||
| Line 26: | Line 28: | ||
* message : If send is true and call by register : a message to be shown to the user | * message : If send is true and call by register : a message to be shown to the user | ||
* 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. | ||
[[Category:Plugins events]] | [[Category:Plugins events]] | ||
Revision as of 08:13, 9 September 2016
Usage
This event can be used each time a token is send by the admin user via the Limesurvey admin panel.
Input
The event receives the following information:
- type : Email type (reminder, invitation, confirm or register (New in 2.06 ))
- model : model used in survey_languagesettings table (remind, invite, confirm or register (New in 2.51.5 ))
- survey : The survey id (New in 2.51.5 ))
- subject : Email subject
- to : Recipient(s)
- body : Email body content
- from : Sender(s)
- token : Raw token data in an array .
Possible output
The following information can be set in the event:
- subject : Email subject
- to : Recipient(s)
- body : Email body content
- from : Sender(s)
- 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 call by register : a message to be shown to the user
- error : If set and "send" is true, log the error as failed email attempt.