Configuring the use of macros in email notification templates
July 4, 2024
ID 56706
A macro is a fill element used in event notification templates. In the text of a notification generated based on the template, the macro is replaced with a certain value.
Macro syntax: %MACRO_NAME%
The table below describes the macros that you can use in the text of event notifications (see the table below).
Macros for event notification templates
Macro | Description | Event for which the macro is used |
|---|---|---|
%SERVER_NAME% | Mail server name. | antiVirusBasesOutOfDate, antiVirusBasesObsolete, antiSpamBasesOutOfDate, antiSpamBasesObsolete, messageBackupFailed, severalMessagesBackupFailed, severalBackupCleanupAttemptsFailed, backupAlmostFull, licenseExpiresSoon, licenseExpired, licenseBlacklisted |
%PRODUCT_NAME% | Application name. | antiVirusBasesOutOfDate, antiVirusBasesObsolete, antiSpamBasesOutOfDate, antiSpamBasesObsolete, messageBackupFailed, severalMessagesBackupFailed, severalBackupCleanupAttemptsFailed, backupAlmostFull, licenseExpiresSoon, licenseExpired, licenseBlacklisted |
%BASES_ISSUE_DATE% | Release date of Anti-Virus databases or Anti-Spam databases. | antiVirusBasesOutOfDate, antiVirusBasesObsolete, antiSpamBasesOutOfDate, antiSpamBasesObsolete |
%OUTDATED_DAYS% | Number of days that have passed since the last update of Anti-Virus databases or Anti-Spam databases. | antiVirusBasesOutOfDate, antiVirusBasesObsolete, antiSpamBasesObsolete |
%OUTDATED_HOURS% | Number of hours that have passed since the last update of Anti-Spam databases. | antiSpamBasesOutOfDate |
%SMTP_MESSAGE_ID% | Message header. | messageBackupFailed, scanStatusAlertForAdmin, scanStatusAlertForOthers |
%MESSAGES_COUNT% | Number of messages that were not able to be placed in Backup or the total number of messages in Backup. | severalMessagesBackupFailed, backupAlmostFull |
%MINUTES% | Amount of time spent attempting to place messages in Backup or attempting automatic deletion of messages from Backup. | severalMessagesBackupFailed, severalBackupCleanupAttemptsFailed |
%ATTEMPTS% | Number of attempts to automatically delete messages from Backup. | severalBackupCleanupAttemptsFailed |
%MESSAGES_SIZE% | Total size of messages in Backup, in megabytes. | backupAlmostFull |
%MAX_BACKUP_SIZE% | Maximum size of Backup. | backupAlmostFull |
%LICENSE_NUMBER% | Key linked to the license. | licenseExpiresSoon, licenseExpired, licenseBlacklisted |
%EXPIRATION_DAYS% | Number of days until license expiration. | licenseExpiresSoon |
%EXPIRATION_DATE% | License expiration date. | licenseExpired |
%SENDER% | Mail sender's address. | scanStatusAlertForAdmin, scanStatusAlertForRecipient, scanStatusAlertForOthers |
%ALL_RECIPIENTS% | Addresses of all recipients of the original message. | scanStatusAlertForAdmin, scanStatusAlertForSender, scanStatusAlertForOthers |
%AFFECTED_RECIPIENTS% | Addresses of the original message recipients affected by the event described in the notification. | scanStatusAlertForAdmin, scanStatusAlertForOthers, messageBounce |
%AFFECTED_RULES% | Rules for processing the original message that were affected by the event described in the notification. | scanStatusAlertForAdmin, scanStatusAlertForOthers |
%MESSAGE_ID% | Identification number of the message within the program. | scanStatusAlertForAdmin, scanStatusAlertForOthers |
%SUBJECT% | Subject of an original message. | scanStatusAlertForAdmin, scanStatusAlertForSender, scanStatusAlertForRecipient, scanStatusAlertForOthers |
%DATE% | Message processing date. | scanStatusAlertForAdmin, scanStatusAlertForSender, scanStatusAlertForRecipient, scanStatusAlertForOthers |
%MESSAGE_ACTION% | Action performed on the message by the program. | scanStatusAlertForAdmin, scanStatusAlertForSender, scanStatusAlertForRecipient, scanStatusAlertForOthers |
%DATA_BEGIN% | Service macro for designating the beginning of the list of macros for an attachment. | scanStatusAlertForAdmin, scanStatusAlertForSender, scanStatusAlertForRecipient, scanStatusAlertForOthers |
%DATA_END% | Service macro for designating the end of the list of macros for an attachment. | scanStatusAlertForAdmin, scanStatusAlertForSender, scanStatusAlertForRecipient, scanStatusAlertForOthers |
%OBJECT_NAME% | Name of the detected object. The body of the macro notification contains information about the results of scanning message attachments or the Message value if a phishing or malicious link is present in the text of the message. In the notification subject, the Message value is inserted in place of the macro. | scanStatusAlertForAdmin, scanStatusAlertForSender, scanStatusAlertForRecipient, scanStatusAlertForOthers |
%OBJECT_SIZE% | Size of the attachment or data regarding the phishing/malicious link. The body of the macro notification contains information about the results of scanning individual parts of the message. Parts of the message consist of attachments or phishing/malicious links in the message text. The subject of the macro notification contains information about the final result of the message scan based on a scan of all parts of the message. | scanStatusAlertForAdmin, scanStatusAlertForSender, scanStatusAlertForRecipient, scanStatusAlertForOthers |
%STATUS% | Message scan result. The body of the macro notification contains information about the results of scanning individual parts of the message and indicates the names of the detected objects. Parts of the message consist of attachments or phishing/malicious links in the message text. Applicable for the following statuses:
| scanStatusAlertForAdmin, scanStatusAlertForSender, scanStatusAlertForRecipient, scanStatusAlertForOthers |
%OBJECT_ACTION% | Action taken by the program on the attachment or phishing/malicious link. The body of the macro notification contains information about the results of scanning individual parts of the message. The subject of the macro notification contains information about the final result of the message scan based on a scan of all parts of the message. | scanStatusAlertForAdmin, scanStatusAlertForSender, scanStatusAlertForRecipient, scanStatusAlertForOthers |
