Mail Listeners

Mail Listeners in Lucee

Mail Listeners can be configured to be triggered before and after sending email (only for email sending as async).

These follow the same pattern as Query Listeners.

This is available as an experimental feature in Lucee 5.3 and is officially supported in Lucee 6.0.

Info

Note: Mail listener only triggered when the mail sending as async (spool enable).

It can be configured:

You can change the arguments (content) of an email in via the before listener method, by returning a struct, with some or all of the following keys:

  • from
  • to
  • bcc
  • replyTo
  • failTo
  • subject

(ex: {from:"modified@lucee.org", to:"modifiedto@lucee.org"})

A Mail Listener is a component with two methods, before() and/or after(). You can have other methods in your listener component, but Lucee will only call these two.

Also a Mail Listener can be a struct that has a keys before and/or after with closure as value, OR a closure (that is triggered after sending the email)

this.mail.listener = {
	before = function () {
		return arguments;
	}
	,after = function () {
		if (structKeyExists(arguments,"exception")) {
			writelog(text:"Sending mail failed, from:#arguments.detail.from# to:#arguments.detail.to# 
			with message:#arguments.exception.message# ", file:"mailFailed.log");
           	 }
	}
};
OR
this.mail.listener = function () {
	if (structKeyExists(arguments,"exception")) {
		writelog(text:"Sending mail failed, from:#arguments.detail.from# to:#arguments.detail.to# 
		with message:#arguments.exception.message# ", file:"mailFailed.log");
	}
};

Examples

i.e. MailListener.cfc

component {
	function before() {
		// modified the from and to mails
		return {from:"modified@testlucee.org", to:"modifiedto@testlucee.org"};
	}
	function after() { 
		return arguments;
	}
}

To add an Application-wide Mail Listener, add the following to your Application.cfc:

this.mail.listener = new MailListener();

To add a Mail Listener to an individual <cfmail> tag (listeners defined in the listener attribute overwrites any mail listener defined in the Application.cfc / <cfapplication>:

<cfset listener = new MailListener()>
<cfmail from="testlistener@testlucee.org" to="testlistener@testlucee.org" server="stmp.testlucee.org" port="25" 
	username="testlistener@testlucee.org" password="***********" subject="Test listener" listener="#listener#">
	test listener mail body
</cfmail>

Dump of arguments to the Mail Listener before() method

Mail Listener Before()

Dump of arguments to the Mail Listener after() method (cfmail)

You can see the from and to mail IDs were changed in the arguments to the after function, the arguments struct contains the modified from and to keys from the before function.

Mail Listener After()

See also