Using macros in the Backup Digest template

16 April 2024

ID 238456

A macro is a substitution element used in a Backup Digest template. In the text of the digest generated based on the template, the macro is replaced with a certain value.

Macro syntax: %MACRO_NAME%

The macros that you can use in the Backup digest text are listed in the table below.

KSMG version 2.1 does not support the %TOTAL_MESSAGES_COUNT% macro.
If a template with this macro was created in a previous version of the application, after updating to the new version of KSMG, the macro appears in the message as a "%TOTAL_MESSAGES_COUNT%" string.

Macros for the body of the Backup Digest

 

Macro

Description

%PRODUCT_NAME%

Application name — KSMG.

%DATE%

Date and time when the Backup Digest is sent in the time zone of the Control node. The date and time format is configured by the administrator in Backup Digest template settings.

%NEW_MESSAGES_COUNT%

Number of new messages in the user's personal Backup since the previous digest.

%WEB_CONSOLE_LINK%

Link to the user's personal Backup.

%BACKUP_PREVIEW_SIZE%

Maximum number of information lines about Backup messages that the digest can contain.

%BACKUP_PREVIEW_LINE%

Information line about the message in Backup.

%UNSUBSCRIBE_LINK%

Unsubscribe link for Backup Digest. The language of the page matches the language saved in cookie files. If the cookie files do not have the language saved, the page is displayed in English.

The macros that you can use in the Backup message information line are listed in the table below.

Macros for the Backup message information line

 

Macro

Description

%SENDER%

Sender address of the original message.

%RECIPIENTS%

Addresses of all recipients of the original message.

%SUBJECT%

Subject of an original message.

%DATE%

Date and time when the message was placed in Backup.

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.