Actions

BeforeTokenEmail: Difference between revisions

From LimeSurvey Manual

m (build fix)
(minor corrections)
Line 1: Line 1:
{{FeatureStarting|2.05 build 140404}}  
{{FeatureStarting|2.05 build 140404}}  


'''When'''
'''Usage'''


Each time a token is send my admin user with the admin panel.
This event can be used each time a token is send by the admin user via the Limesurvey admin panel.


'''Input'''
'''Input'''


The event receives the following information:
The event receives the following information:
* type : Email type sended (remind, invite)
* type : Email type(remind, invite)
* subject : Subject line
* subject : Email subject
* to : Recipient(s)
* to : Recipient(s)
* body : Email body content
* body : Email body content
Line 19: Line 19:


The following information can be set in the event:
The following information can be set in the event:
* subject : Subject line
* subject : Email subject
* to : Recipient(s)
* to : Recipient(s)
* body : Email body content
* body : Email body content
* from : Sender(s)
* 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.
* 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.
* 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.



Revision as of 11:42, 7 April 2014

 Hint: This features is available starting in version 2.05 build 140404


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(remind, invite)
  • subject : Email subject
  • to : Recipient(s)
  • body : Email body content
  • from : Sender(s)
  • token : Raw token data


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.
  • error : If set and "send" is true, log the error as failed email attempt.