Notification Sets - Notification Set Variables

This article contains information on using variables to customize Mimecast notification sets, including variable categories, options, and examples for tailoring notifications to suit specific needs.

Overview

Notification Sets are used to notify your End Users of why an email / attachment has not been delivered, or about messages that are pending delivery. The notifications controlled by the notification set can contain variables included as part of the notification's body. These variables allow you to customize the text displayed inside a notification set.

Additionally using variables, certain notification set attributes can be amended. For example, a notification about a failed outbound message delivery has variables that are populated when sent to the initial sender. This provides you with details of the failed message (e.g. recipient details, subject, the reason for failure). Using variables, you can customize the content displayed in the notifications to suit their internal environment.

Additional variables are available for Auto Response notifications.

Using Variables to Amend Notification Sets

As part of the suite of notifications, the variables that can be used in the body of the message are grouped into categories. In each category, various options can be included in the actual notification. Mimecast default's notifications include specific variables, and while not all options are required, this page provides information on all the available options.

The tables below detail the variable categories available with associated options, as well as which categories can be used in which notification. To determine the potential changes for your notifications:

• Look at the categories available for each notification (Table 1).
• Check the full list of options available in each of these categories (Table 2).
• Check the available variables that can be used in Secure Messaging-specific notifications (Table 3).

A worked example is provided in the "Example: Delivery Failure Notification" below to highlight the potential use of the additional variables.

Copyright Year on Notification Sets

The following variables can be used to automatically update the copyright year on all Notification Sets:

• For the Plain Text Body:
  Update from
  © 2025 Mimecast Services
  To
  [copyrightsymboltext] 2003 - [copyrightdate] [copyrightattributiontext]
• For the HTML Body:
  Update from
  © 2025 Mimecast Services Limited.
  To:
  [copyrightfooter_html]

Any newly created Notification Sets have these variables included automatically, however old ones do not include them.

Table 1: Notifications with Categories Available and Defaults Included

This table lists the notifications included in notification sets (e.g. those notifications that can be amended) and what variable categories can be used in each notification type. Variable categories are the groups of options and are shown in angled brackets (e.g. "<>"). The options listed in the third column are the various options that are currently used in the Mimecast defaults, and match up to the options in Table 2.

A "terseinfo" notification informs the recipient which policy triggered the delivery failure. A "fullinfo" notification informs the recipient of the specific reason why the certain policy caused delivery failure.

Notification	Variable Categories	Mimecast Defaults Variables
Attachment Link and Attachment Block	<addresses> <message> <policy> <attachment> <downloadurl> <releaseurl> <attachurl> <scaledsize>	filename size downloadurl attachurl releaseurl
Attachment Policy	<notice> <addresses> <message> <policy>	sender recipient subject date policy hold terseinfo fullinfo
Attachment Release	<notice> <addresses> <message> <attachment> <attlogid>	mailfrom subject date
Bad Structure Message	<notice> <addresses> <message> <policy>	sender recipient subject date hold
Email Delivery Warning	<notice> <addresses> <message> <bounce>	mailto message terseinfo fullinfo attempts hours
Email Delivery Failure
Forgotten Password Confirmation	<url_line>	url_line mppurl customer_name
Hold for Review	<notice> <addresses> <message> <policy>	sender recipient subject date hold terseinfo fullinfo
Hold for Review Rejection	<notice> <addresses> <message> <revieweraddress> <reviewerdomain> <reviewername> <reason> <info>	mailfrom mailto mailtoname subject date reviewer reviewname reason terseinfo fullinfo
Password Notification	<notice> <addresses> <logonurl> <password>	mppurl email password
Privileged Access	<notice> <addresses> <admin> <type> <date> <info>	admin type date terseinfo fullinfo
Large File Receive Invitation Sent		lfrrecipients lfsexpirydate lfscapsize
Large File Receive (Keyless)		lfsexpirydate lfscapsize sender uploadurl
Large File Send / Receive (Key)		sender filedownloadurl uploadurl lfsfileslist lfsexpirydate lfscapsize
Large File Send / Receive (Keyless)
Large File Send (Keyless)		sender filedownloadurl lfsfileslist lfsexpirydate
Large File Send (Key)
Large File Send Key Reset		sender lfspassword lfsexpirydate
Message Bounce	<notice> <addresses> <message> <bounce>	mailto message terseinfo fullinfo attempts hours
Message Digest Row		digestdate digestreasontext digestreleaseurl digestreleaseallurl digestblockurl digestblockallurl digestwhiteurl digestwhiteallurl
Message Hold Digest	<addresses> <emaillist>	emaillist
Secure Messaging Message Notification	<notice> <addresses> <message> <policy> <logonurl>	customer-name view-message-url new-password-url
Secure Messaging Forgotten Password		customer-name mpp-link-reset-pwd
Secure Messaging Internal Forgotten Password		customer-name
Secure Messaging Password Expiry Notification		customer-name mpp-link-reset-pwd
Secure Messaging Initial Message Notification		customer-name mpp-link-create-pwd view-message-url
Email Incident Response - End-user Notification		reported-email-subject reporter-email-address reported-email-classification

Due to how our regular expressions are processed, it is possible for the Matched Text field to be empty in Content Examination notifications with the 'fullinfo' variable specified. An example is where forward and backwards lookup regular expressions or wildcards (*) are used in Content Examination policies.

Table 2: Variable Categories with Available Options

This table identifies the variable categories, and the available options in each category.

Variable Category	Tags
<notice>	noticefromaddress noticefromdomain noticefromname noticetoaddress noticetodomain noticetoname noticetime
<addresses>	postmaster postmasteraddress postmasterdomain postmastername fromaddress fromdomain fromname toaddress todomain toname
<addresses>	mailfrom mailfromdomain mailfromname mailto mailtodomain mailtoname
<message>	sender recipient subject messagedate receiptdate messageid
<policy>	policy hold (not CCM) terseinfo (not CCM) fullinfo (not CCM)
<logonurl>	url mppurl email
<bounce>	attempts hours minutes message terseinfo fullinfo sent originalheaders
<attachment>	filenamesize

Table 3: Secure Messaging and Notification Variables

Variables

The table below shows the available variables that can be used in Secure Messaging-specific notifications and what will be shown as a result of using each variable.

Notification	Variable	Description
Secure Messaging	[customer-name]	This displays your Company Display Name from your branding package (if used) or the value of your Mimecast Account Name as detailed in the Account | Account Settings menu of the Mimecast Administration Console.
	[view-message-url]	This displays the links to the received message.
	[new-password-url]	This displays the link to the password reset URL.
Secure Messaging Password Notification	[customer-name]	This will show your Company Display Name from your branding package (if used) or the value of your Mimecast Account Name as detailed in the Account | Account Settings menu of the Mimecast Administration Console.
	[secure-messaging-url]	This will show a link to access the Secure Messaging portal.
	[secure-messaging-email]	This will show the email address of the recipient of the Secure Message.
	[secure-messaging-pwd]	This shows a one-time random password.
Secure Messaging Password Reset Confirmation	[customer-name]	This shows the name of the Secure Message recipient.
	[mpp-link-reset-pwd]	This shows a password reset link.
Secure Messaging Read Receipt	[recipient-name]	This shows the name of the Secure Message recipient.
	[sender-name-email]	This shows the Email address of the sender of the Secure Message.
	[recipient-name-email]	This shows the Email address of the recipient of the Secure Message.
	[secure-message-subject]	This shows the subject of the Secure Message.
	[secure-message-read-date]	This shows the date that the Secure Message was read.
	[secure-message-read-time]	This shows the time that the Secure Message was read.

Images

Apart from these variables, there are two accepted image variables:

•  
  •  
    • 'mimecast-logo'
    • 'brand-logo'

These can be used for any notifications in the HTML Body.
For example, <img src="mimecast-logo" /> is allowed in the HTML Body of the notification.

Amending Notification Variables

Before amending a notification, ensure you have completed the following steps:

1. Note down the available variable categories for the notification you wish to amend (Table 1).
2. For each category, choose the options you want to use (Table 2).
3. Once you are ready to amend the notification, see Configuring Notification Sets on how to customize the notification.

Example: Changing the Delivery Failure Notification

This example demonstrates the usage of variable categories and options in the delivery failure notification.

You view the current notification sets used, by using the following steps:

1. List the Notification Sets Definitions.
2. Click on the Copy Default button to make a copy of the existing notification set.
3. Open the Delivery Failure Notification notification.
4. View the default text included below:

This is a delivery failure notification message indicating that an email you addressed to email address:
     -- [mailto]
     could not be delivered. The problem appears to be:

     -- [message]
     Additional information follows:-- [info]
     This condition occurred after [attempts] attempt(s) to deliver over a period of [hours] hour(s).

If you sent the message to multiple recipients, you will receive one of these messages for each one that failed delivery. The current variables used in the default text are [mailto], [message], [info], [attempts], and [hours].

You can include additional information regarding the bounce, by using the following steps:

1. Check Table 1 to view the available categories that can be used in this notification. These are:

• <notice>
• <addresses>
• <message>
• <bounce>

2. Check Table 2 to determine which options are available from these categories. For example, you may wish to include variables such as messagedate or messageid.
3. Once you have selected the items to be added / removed, amend the text body of the notification to include the required variables.

When amending the actual notification, the variable should be written in lowercase and in square brackets (e.g. [downloadurl]).

Here is an example of how to edit the message text, by making use of some of the additional variables. This is a delivery failure notification message indicating that an email [mailfrom] addressed to email address:

-- [mailto]
With subject [subject] sent on the [messagedate]
could not be delivered. The problem appears to be:
-- [message]
Additional information follows:

-- [info]

This condition occurred after [attempts] attempt(s) to deliver over a period of [hours] hour(s) and [minutes] minute(s).

We recommend testing the new notification on a small group before applying it to all users.

See Also..

• Configuring Notification Sets
• Notification Sets Management
• Notification Reference List