Actions

BeforeTokenEmail: Difference between revisions

From LimeSurvey Manual

(minor corrections)
mNo edit summary
Line 8: Line 8:


The event receives the following information:
The event receives the following information:
* type : Email type(remind, invite)
* type : Email type(remind, invite or register{{NewIn|v=2.06}})
* subject : Email subject
* subject : Email subject
* to : Recipient(s)
* to : Recipient(s)
Line 24: Line 24:
* 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.
* 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.



Revision as of 15:12, 14 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 or register (New in 2.06 ))
  • 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.
  • 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.