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

01 апреля 2024

ID 56706

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

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

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

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

 

Макрос

Описание

%NODE_IP%

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

%NODE_PORT%

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

%PRODUCT_NAME%

Название приложения – KSMG.

%SMTP_MESSAGE_ID%

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

%SENDER%

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

%SENDER_IP%

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

%ALL_RECIPIENTS%

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

%AFFECTED_RECIPIENTS%

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

%AFFECTED_RULES%

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

%MESSAGE_ID%

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

%SUBJECT%

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

%DATE%

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

%MESSAGE_ACTION%

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

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

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

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

%DATA_BEGIN%

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

%DATA_END%

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

%OBJECT_NAME%

Имя обнаруженного объекта.

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

  • между макросами %DATA_BEGIN% и %DATA_END% подставляется имя вложения сообщения;
  • вне макросов %DATA_BEGIN% и %DATA_END% подставляется значение Message.

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

%OBJECT_SIZE%

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

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

  • между макросами %DATA_BEGIN% и %DATA_END% подставляется размер вложения сообщения;
  • вне макросов %DATA_BEGIN% и %DATA_END% подставляется размер сообщения целиком.

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

%STATUS%

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

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

  • между макросами %DATA_BEGIN% и %DATA_END% подставляются статусы проверки вложений модулями Антивирус и Контентная фильтрация;
  • вне макросов %DATA_BEGIN% и %DATA_END% подставляются статусы, присвоенные по результатам проверки сообщению целиком (если для этих статусов включена отправка уведомлений в правиле).

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

Если статусов несколько, они перечисляются через запятую.

%OBJECT_ACTION%

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

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

  • между макросами %DATA_BEGIN% и %DATA_END% подставляются действия над вложениями, выполненные модулями Антивирус или Контентная фильтрация (Blocked, Not blocked, Disinfected), или действие над сообщением целиком, выполненное модулем Анти-Фишинг.
  • вне макросов %DATA_BEGIN% и %DATA_END% подставляется действие, выполненное над сообщением целиком.

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

     

Вам помогла эта статья?
Что нам нужно улучшить?
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!