BeforeEmail - Revision history

DenisChenu: token : null

2022-07-21T16:14:19Z

token : null

2022-07-21T13:46:33Z

Add the name of events

← Older revision		Revision as of 15:46, 21 July 2022
Line 9:		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 : default is `unknow`, and deprecated usage of function is `deprecated` (for example for plugins not updated), partial list:		* type : Email type : default is <code>unknow</code>, and deprecated usage of function is <code>deprecated</code> (for example for plugins not updated), partial list:
	** Token email		** Token email (beforeTokenEmail)
	*** <code>invite</code>,		*** <code>invite</code>,
	*** <code>remind</code>,		*** <code>remind</code>,
	*** <code>register</code>,		*** <code>register</code>,
	*** <code>confirm</code>,		*** <code>confirm</code>,
	** Survey email		** Survey email (beforeSurveyEmail)
	*** <code>savesurveydetails</code> (during survey or by admin),		*** <code>savesurveydetails</code> (during survey or by admin),
	*** <code>admin_notification</code>,		*** <code>admin_notification</code>,

2022-07-21T13:45:02Z

send === false for message and error

← Older revision		Revision as of 15:45, 21 July 2022
Line 41:		Line 41:
	* from : From email and name		* from : From email and name
	* bounce : Return-Path		* 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.		* send : If true Limesurvey will send the email. Setting this to false (strict comparison) 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		* message : If send is false 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 false, log the error as failed email attempt.

	'''Usage of mailer'''		'''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.		The plugin event 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 :		A sample code can be :

2022-07-08T14:54:03Z

← Older revision		Revision as of 16:54, 8 July 2022
Line 66:		Line 66:

	* [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/tree/master/application/core/plugins/mailSenderToFrom mailSenderToFrom]
	* [https://github.com/Xites/LS_mailDKIM mailDKIM]		* [https://github.com/Xites/LS_mailDKIM mailDKIM]
	* [https://github.com/Xites/LS_mailEmbedImages mailEmbedImages]		* [https://github.com/Xites/LS_mailEmbedImages mailEmbedImages]

2021-02-09T16:27:56Z

Add type list

@@ Line 9: / Line 9: @@
 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'
+* type : Email type : default is `unknow`, and deprecated usage of function is `deprecated` (for example for plugins not updated), partial list:
 * subject : Email subject
 * to : Recipient(s) with format <code><nowiki>[email,name]</nowiki></code>

2021-01-04T13:52:28Z

2 external examplzs plugin

← Older revision		Revision as of 15:52, 4 January 2021
Line 54:		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]
			* [https://github.com/Xites/LS_mailDKIM mailDKIM]
			* [https://github.com/Xites/LS_mailEmbedImages mailEmbedImages]

	'''See also'''		'''See also'''

2020-04-20T10:20:41Z

2020-02-04T06:36:04Z

Add class link (to github)

← Older revision		Revision as of 08:36, 4 February 2020
Line 48:		Line 48:
	</syntaxhighlight>		</syntaxhighlight>

	Check '''mailSenderToFrom''' core plugin for another usage of mailer to set the sender, the Response-To and the From-To.		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'''

2020-02-04T06:32:50Z

$this->getEvent()->set('body',$body); and not get

← Older revision		Revision as of 08:32, 4 February 2020
Line 1:		Line 1:
	{{FeatureStarting\|4.0.0}}		{{FeatureStarting\|4.0.0}}

	~~{{Alert\|This feature is currently implemented in beta version of LimeSurvey.}}~~


	'''Usage'''		'''Usage'''
Line 48:		Line 45:
	$rawBody = $oPurifier->purify($rawBody);		$rawBody = $oPurifier->purify($rawBody);
	$body = $mailer->doReplacements($rawBody);		$body = $mailer->doReplacements($rawBody);
	$this->getEvent()->~~get~~('body',$body);		$this->getEvent()->set('body',$body);
	</syntaxhighlight>		</syntaxhighlight>

2019-06-11T08:02:43Z

Add mailer usage sample

@@ Line 34: / Line 34: @@
 * 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.
 '''Example'''

← Older revision		Revision as of 12:20, 20 April 2020
Line 54:		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]]