Notification Set Variables

Document created by user.oxriBaJeN4 Employee on Sep 22, 2015Last modified by user.oxriBaJeN4 Employee on Sep 4, 2019
Version 14Show Document
  • View in full screen mode

Notification Sets are used to notify end users 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 administrators 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).
A worked example is provided in the "Example: Delivery Failure Notification" below to highlight the potential use of the additional variables.

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 Receive (Key)

Large File Send / Receive (Keyless)

sender

filedownloadurl

uploadurl

lfsfileslist

lfsexpirydate

lfscapsize

Large File Send / Receive (Key)

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

digestblackurl

digestwhiteurl

Message Hold Digest

<addresses>

<emaillist>

emaillist

Secure Messages

<notice>

<addresses>

<message>

<policy>

<logonurl>

mppurl

Secure Messaging Forgotten Password

customer-name

Secure Messaging Internal Forgotten Password

Secure Messaging Message

customer-name

view-message-url

new-password-url

Secure Messaging Password

customer-name

secure-messaging-url

secure-messaging-email

secure-messaging-pwd

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 within 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

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, follow the Configuring Notification Sets Definitions and Policies page 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. To view the current notification sets used:

  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].

 

To include additional information regarding the bounce:

  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...

 

4 people found this helpful

Attachments

    Outcomes