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

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

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

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

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

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

 

Макрос

Описание

%NODE_IP%

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

%NODE_PORT%

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

%PRODUCT_NAME%

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

%SMTP_MESSAGE_ID%

Заголовок сообщения Message-Id.

%SENDER%

Адрес отправителя сообщения.

%SENDER_IP%

IP-адрес отправителя сообщения.

%ALL_RECIPIENTS%

Адреса всех получателей исходного сообщения.

%AFFECTED_RECIPIENTS%

Список адресов получателей исходного сообщения, имеющих отношение к сработавшим модулям проверки, по которым сформированы уведомления.

Адреса берутся из SMTP-сессии (значения команды RCPT TO).

%AFFECTED_RULES%

Список идентификаторов сработавших правил.

%MESSAGE_ID%

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

%SUBJECT%

Тема исходного сообщения.

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

%DATE%

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

%MESSAGE_ACTION%

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

Возможные значения:

  • Skipped.
  • Disinfected.
  • AttachmentDeleted.
  • Deleted.
  • Rejected.

Если сообщение помещено в Хранилище, то через запятую после действия указывается backed up.

%DATA_BEGIN%

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

%DATA_END%

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

%OBJECT_NAME%

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

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

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

В теме уведомления вместо макроса всегда подставляется значение Message.

%OBJECT_SIZE%

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

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

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

В теме уведомления вместо макроса всегда подставляется размер сообщения целиком.

%STATUS%

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

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

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

    В теме уведомления вместо макроса всегда подставляются статусы, присвоенные по результатам проверки сообщения целиком.

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

%OBJECT_ACTION%

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

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

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

    В теме уведомления на место макроса всегда подставляется действие, выполненное над сообщением целиком.

     

В начало