Использование макросов в шаблонах примечаний

Макрос – это элемент подстановки, используемый в шаблонах примечаний к сообщениям. В формируемом на основе шаблона тексте примечания макрос заменяется на некоторое значение.

Синтаксис макроса: %ИМЯ_МАКРОСА%

Значения макросов автоматически подставляются на английском языке. Переключение языков для макросов недоступно.

В текстах уведомлений о срабатывании правила можно использовать следующие макросы (см. таблицу ниже).

Макросы для шаблонов примечаний

 

Макрос

Описание

%PRODUCT_NAME%

Название приложения – Kaspersky Secure Mail Gateway.

%NODE_IP%

IP-адрес узла кластера, на котором было обработано сообщение.

%NODE_PORT%

Порт подключения к узлу кластера, на котором было обработано сообщение.

%MESSAGE_ID%

Идентификатор, присвоенный сообщению приложением KSMG.

%DATE%

Дата получения сообщения.

%DATA_BEGIN%

Служебный макрос для обозначения начала списка вложений.

%DATA_END%

Служебный макрос для обозначения конца списка вложений.

%OBJECT_NAME%

Имя обнаруженного объекта. Если имя объекта содержит ссылку, KSMG делает ссылку неактивной с помощью добавления пробелов.

Значение макроса зависит от его расположения в примечании:

  • Между макросами %DATA_BEGIN% и %DATA_END%:
    • Если сработало выражение модуля Контентная фильтрация с условием выражения для атрибута Тип вложения, Имя вложения или Размер MIME-части, вместо макроса подставляется значение Message и имя вложения сообщения, на котором сработало это условие.
    • Если сработало выражение модуля Контентная фильтрация с условием выражения для других атрибутов или сработало выражение модуля Проверка подлинности или сработали модули Анти-Фишинг, Проверка ссылок, Анти-Спам или Защита KATA, вместо макроса подставляется значение Message.
    • Если в результате работы модуля Обезвреживание содержимого сообщений произошла ошибка сканирования, превышено заданное время ожидания или размер сообщения, вместо макроса подставляется значение Message.
    • Если сработал модуль Антивирус и приложению удалось получить статус по сообщению целиком, но не удалось выявить конкретное вложение, которому присвоен этот статус, вместо макроса подставляется значение Message.
    • Если сработали модули Антивирус или Обезвреживание содержимого сообщений, вместо макроса подставляются имена вложений сообщения, на которые сработал модуль.
  • Вне макросов %DATA_BEGIN% и %DATA_END% подставляется значение Message.

%OBJECT_SIZE%

Размер сообщения целиком или отдельных его вложений.

Значение макроса зависит от его расположения в примечании:

  • Между макросами %DATA_BEGIN% и %DATA_END%:
    • Если сработало выражение модуля Контентная фильтрация с условием выражения для атрибута Тип вложения, Имя вложения или Размер MIME-части, вместо макроса подставляется размер сообщения целиком и размер вложения.
    • Если сработало выражение модуля Контентная фильтрация с условием выражения для других атрибутов или или сработало выражение модуля Проверка подлинности или сработали модули Анти-Фишинг, Проверка ссылок, Анти-Спам или Защита KATA, вместо макроса подставляется размер сообщения целиком.
    • Если в результате работы модуля Обезвреживание содержимого сообщений произошла ошибка сканирования, превышено заданное время ожидания или размер сообщения, вместо макроса подставляется размер сообщения целиком.
    • Если сработал модуль Антивирус и приложению удалось получить статус по сообщению целиком, но не удалось выявить конкретное вложение, которому присвоен этот статус, вместо макроса подставляется размер сообщения целиком.
    • Если сработали модули Антивирус или Обезвреживание содержимого сообщений, вместо макроса подставляются размеры вложений сообщения, на которые сработал модуль.
  • Вне макросов %DATA_BEGIN% и %DATA_END% подставляется размер сообщения целиком.

%STATUS%

Результат проверки сообщения или вложения.

Значение макроса зависит от его расположения в примечании:

  • Между макросами %DATA_BEGIN% и %DATA_END%:
    • Если сработало выражение модуля Контентная фильтрация с условием выражения для атрибута Тип вложения, Имя вложения или Размер MIME-части, вместо макроса подставляются статус сообщения, присвоенный модулем Контентная фильтрация по результатам проверки сообщения целиком и статус вложения, присвоенный по результатам проверки вложения.
    • Если сработало выражение модуля Контентная фильтрация с условием выражения для других атрибутов или сработало выражение модуля Проверка подлинности или сработали модули Анти-Фишинг, Проверка ссылок, Анти-Спам или Защита KATA, вместо макроса подставляются статусы, присвоенные по результатам проверки сообщения целиком этими модулями.
    • Если сработал модуль Антивирус и приложению удалось получить статус по сообщению целиком, но не удалось выявить конкретное вложение, которому присвоен этот статус, вместо макроса подставляется статус, присвоенный по результатам проверки сообщения целиком.
    • Если сработали модули Антивирус или Обезвреживание содержимого сообщений, вместо макроса подставляются статусы, присвоенные вложениям по результатам проверки модулем.
    • Если в результате работы модуля Обезвреживание содержимого сообщений произошла ошибка сканирования, превышено заданное время ожидания или размер сообщения, вместо макроса подставляется статус, присвоенный по результатам проверки сообщения целиком.
  • Вне макросов %DATA_BEGIN% и %DATA_END% подставляются статусы, присвоенные по результатам проверки сообщения целиком.

Статус подставляется вместо макроса, если в параметрах модулей, присвоивших этот статус, включено добавление примечаний. Если статусов несколько, они перечисляются через запятую.

%OBJECT_ACTION%

Действие приложения над сообщением или вложением.

Значение макроса зависит от его расположения в примечании:

  • Между макросами %DATA_BEGIN% и %DATA_END%:
    • Если приложению удалось получить статус проверки модулем Контентная фильтрация с условием выражения для атрибута Тип вложения, Имя вложения или Размер MIME-части, вместо макроса подставляются действия, выполненные над сообщением целиком и над вложениями (Blocked, Not blocked).
    • Если приложению удалось получить статус проверки модулем Контентная фильтрация с условиями выражения для других атрибутов или сработало выражение модуля Проверка подлинности или сработали модули Анти-Фишинг, Проверка ссылок, Анти-Спам или Защита KATA, вместо макроса подставляется действие, выполненное над сообщением целиком.
    • Если приложению удалось получить статус проверки модулем Антивирус по сообщению целиком, но не удалось выявить конкретное вложение, которому присвоен этот статус, вместо макроса подставляется действие, выполненное над сообщением целиком.
    • Если приложению удалось получить статусы проверки вложений модулем Антивирус, вместо макроса подставляются действия, выполненные над вложениями (Blocked, Not blocked, Disinfected).
    • Если приложению удалось получить статус проверки вложений модулем Обезвреживание содержимого сообщений, вместо макроса подставляются действия, выполненные над вложениями (Disarmed).
    • Если в результате работы модуля Обезвреживание содержимого сообщений произошла ошибка сканирования, превышено заданное время ожидания или размер сообщения, вместо макроса подставляется действие, выполненное над сообщением целиком.
  • Вне макросов %DATA_BEGIN% и %DATA_END% подставляется действие, выполненное над сообщением целиком.

%WEB_CONSOLE_LINK%

Ссылка на персональное Хранилище пользователя.

%WEB_CONSOLE_LINK_MESSAGE%

Ссылка на конкретное сообщение в Хранилище пользователя.

В режиме персонального пользователя при переходе по ссылке открывается окно, содержащее сообщение из персонального Хранилища. Для привилегированного пользователя при наличии соответствующих разрешений при переходе по ссылке открывается окно, содержащее сообщение из общего Хранилища. Если у пользователя есть доступ как к общему, так и персональному Хранилищу, будет открыто сообщение в общем Хранилище.

 

В начало