Макросы, используемые в шаблонах

Во всех шаблонах могут быть использованы следующие макросы:

Макрос

Назначение

$LC*$

Заменяется на строку текста из языкового файла с указанным номером (* – десятичный номер строки, например – $LC150$).

Используемый языковой файл определяется значением макроса $LANG$.

Полученный текст преобразуется в нужную кодировку согласно значениям макросов $CHARSET$ и $CONTENT_TRANSFER_ENCODING$

$POSTMASTER$

Содержит адрес, на который отсылаются уведомления (используется значение параметра конфигурации AdminMail из секции [Notifier])

$FILTER_MAIL$

Содержит адрес, используемый Dr.Web MailD (используется значение параметра конфигурации FilterMail из секции [Notifier])

$HOSTNAME$

Содержит имя хоста, на котором установлен Dr.Web MailD (используется значение параметра конфигурации Hostname из секции [General]).

Данный макрос не может использоваться в циклах, см. Управляющие конструкции

$LANGS$

Содержит список языков, для которых будут формироваться уведомления (задается перечнем значений параметра конфигурации NotifyLangs из секции [Notifier]).

Данный макрос имеет списковый тип и может использоваться в циклах, см. Управляющие конструкции

$LANG$

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

От значения этого макроса зависит интерпретация некоторых других макросов (например, $CHARSET$)

$CHARSET$

Содержит набор символов текущего используемого языка. Набор символов для конкретного языка задается в языковом файле.

Имя текущего языка берется из макроса $LANG$

$CONTENT_TRANSFER_ENCODING$

Содержит Content-Transfer-Encoding для текущего языка. Значение для конкретного языка задается в языковом файле.

Имя текущего языка берется из макроса $LANG$

$TYPE$

Содержит тип содержимого уведомления (HTML или PLAIN).

Определяется значением параметра html в Правилах обработки писем.

$FULLHEADERS$

Содержит полный набор заголовков сообщения электронной почты.

$MSGID$

Содержит внутренний идентификатор сообщения в MTA, из которой пришло письмо

$SUBJECT$

Содержит тему сообщения (если тема не указана – пустой).

При вставке в генерируемое сообщение, при необходимости, вставляемое значение преобразуется в зависимости от текущих значений макросов $CHARSET$ и $CONTENT_TRANSFER_ENCODING$

$DIRECT_SUBJECT$

Содержит тему сообщения (если тема не указана – пустой).

Не подвергается преобразованию кодировки и CTE при вставке

$SENDER$

Содержит адрес оригинального отправителя сообщения

$RCPTS$

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

Данный макрос имеет списковый тип и может использоваться в циклах, см. Управляющие конструкции

$SECURE_RCPTS$

Идентичен $RCPTS$, если получатель один, или устанавливается в значение "Recipients of original message" <#@[]>, если получателей более одного

$LOG_REPORT$

Содержит записи из журнала Dr.Web MailD, касающиеся обработки сообщения, относительно которого генерируется уведомление

$STOP_REASON$

Содержит запись из журнала Dr.Web MailD с основной причиной, по которой было отправлено данное уведомление

$REPORT$

Содержит отчет от подключаемого модуля об анализе сообщения, относительно которого генерируется уведомление

$MESSAGE_STATUS$

Состояние исходного сообщения, указываемое фильтрами POP3 и IMAP, согласно результатам его обработки.

Может принимать значения reject, discard, tempfail и error.

$BLOCK_LIST$

Содержит список строк, описывающих причины блокировки исходного сообщения подключаемым модулем (их может быть больше одной). Например, модуль Drweb, в случае если был обнаружен вирус (или другая известная угроза), вернет его имя. Если блокировка была вызвана по другой причине (например, по выполнению реакции на событие SkipObject), то он возвращает полное значение строки конфигурации <параметр> = <значение>, выполнение которой привело к блокировке письма

$SCAN_STAT$

Содержит статистику проверки сообщения от подключаемого модуля

$ARCHIVE_RECORD$

Содержит имя файла в Карантине

$ORIGINAL_MESSAGE$

Содержит тело оригинального сообщения, для которого формируется уведомление.

Будьте внимательны, вставляя его в уведомление, т.к. если, например, в нем содержался вирус, то сформированное уведомление может быть заблокировано другой антивирусной системой!

$R_MAILS$

Содержит перечень адресов, на которые надо отправлять уведомления. Значение макроса берется из параметра конфигурации Mail в секции [Reports].

Данный макрос имеет списковый тип и может использоваться в циклах, см. Управляющие конструкции

$CO_CLIENT_IP$

Содержит IP-адрес клиента, передавшего сообщение (если известен)

$CO_CLIENT_PORT$

Содержит номер порта, использованного клиентом, передавшим сообщение (если компонент Receiver предоставил эту информацию)

$CO_AUTH$

Содержит yes, если клиент, отправивший исходное письмо, успешно прошел авторизацию (если компонент Receiver предоставил эту информацию)

$CO_SERVER_UNIX_SOCK$

Содержит имя UNIX-сокета, который был использован компонентом Receiver для приема исходного письма (если компонент Receiver предоставил эту информацию)

$CO_SERVER_IP$

Содержит IP-адрес прослушивающего сокета, который был использован компонентом Receiver для приема исходного письма (если компонент Receiver предоставил эту информацию)

$CO_SERVER_PORT$

Содержит порт прослушивающего сокета, который был использован компонентом Receiver для приема исходного письма (если компонент Receiver предоставил эту информацию)

$CO_RS_ID$

Содержит идентификатор компонента Receiver, который принял исходное сообщение (если этот экземпляр компонента Receiver был запущен с непустым идентификатором)

$CO_SENDER_ADDRESS$

Содержит адрес, указанный в значении параметра SenderAddress из Правил для данного сообщения

$Q_CONTROL_BY_EMAILS$

Содержит yes, если разрешены управляющие сообщения для управления Карантином

$TEMPLATES_DIR$

Содержит название каталога, содержащего шаблоны уведомлений.

Этот же путь используется для поиска всех файлов, указанных в шаблоне в директиве include, см. Управляющие конструкции

$Q_REMOVE_TIME$

Содержит время удаления сообщения из Карантина (пустая строка, если время хранения сообщения не ограничено)

$PRODUCT$

Содержит строку "MailD"

$EXT_PRODUCT$

Содержит строку "for Unix mail servers"

Макросы, используемые в отчетах со статистикой

Макрос

Назначение

$R_PLUGINS$

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

Значение макроса берется из параметра конфигурации Names в секции [Reports].

Данный макрос имеет списковый тип и может использоваться в циклах, см. Управляющие конструкции

$R_PERIOD$

Содержит период времени, за который формируется отчет со статистикой

$RP_NAME$

Содержит имя подключаемого модуля, для которого формируется отчет со статистикой

$RP_BLOCKED_OBJECTS_WITH_NUM_AND_PERCENTS$

Содержит вычисленную статистику блокирующих объектов для подключаемого модуля, указанного в макросе $RP_NAME$

$RP_SENDERS_ENVELOPE_WITH_NUM_AND_PERCENTS$

Содержит статистику отправителей блокирующих объектов для подключаемого модуля, указанного в макросе $RP_NAME$

$RP_CLIENT_IP_WITH_NUM_AND_PERCENTS$

Содержит статистику IP-адресов, заблокированных подключаемым модулем, указанным в макросе $RP_NAME$

$RP_BLOCKED_OBJECTS_NUM$

Содержит число объектов, которые будут выведены в статистике блокирующих объектов.

Если значение равно 0,то не будет выведено ни одного объекта, при –1 будут выведены все блокирующие объекты, иначе выводится заданное число блокирующих объектов.

Зависит от значения макроса $RP_NAME$

$RP_SENDERS_ENVELOPE_NUM$

Содержит число отправителей, которые будут выведены в статистике отправителей блокирующих объектов.

Если значение равно 0,то не будет выведено ни одного отправителя, при –1 будут выведены все отправители блокирующих объектов, иначе выводится заданное число отправителей блокирующих объектов.

Зависит от значения макроса $RP_NAME$

$RP_CLIENT_IP_NUM$

Содержит число IP-адресов, которые будут выведены в статистике заблокированных IP-адресов.

Если значение равно 0, то не будет выведено ни одного IP-адреса, при -1 выводятся все IP-адреса, иначе выводится заданное число IP-адресов.

Зависит от значения макроса $RP_NAME$

$RP_TEMPFAIL_SIZE$

Содержит общий размер сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие tempfail

$RP_PASS$

Содержит общее число сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие pass

$RP_REJECT$

Содержит общее число сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие reject

$RP_DISCARD$

Содержит общее число сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие discard

$RP_TEMPFAIL$

Содержит общее число сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие tempfail

$RP_REJECT_PLUS_TEMPFAIL$

Содержит общее число сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, были выполнены действия reject или tempfail

$RP_QUARANTINE$

Содержит общее число сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие quarantine

$RP_REDIRECT$

Содержит общее число сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие redirect

$RP_NOTIFY$

Содержит общее число сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие notify

$RP_PASS_SIZE$

Содержит общий размер сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие pass

$RP_REJECT_SIZE$

Содержит общий размер сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие reject

$RP_DISCARD_SIZE$

Содержит общий размер сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие discard

$RP_REJECT_PLUS_TEMPFAIL_SIZE$

Содержит общий размер сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие reject или tempfail

$RP_QUARANTINE_SIZE$

Содержит общий размер сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие quarantine

$RP_REDIRECT_SIZE$

Содержит общий размер сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие redirect

$RP_NOTIFY_SIZE$

Содержит общий размер сообщений, для которых подключаемым модулем, имя которого указано в макросе $RP_NAME$, было выполнено действие notify

$RP_BLOCK_PERC$

Содержит общий процент сообщений, заблокированных подключаемым модулем, имя которого указано в макросе $RP_NAME$

$RP_BLOCK_SIZE$

Содержит общий размер сообщений, заблокированных подключаемым модулем, имя которого указано в макросе $RP_NAME$

$RP_CHECK_TIME_SUM$

Содержит общее время проверки сообщений подключаемым модулем, имя которого указано в макросе $RP_NAME$

$RP_CHECK_TIME_AVR$

Содержит среднее время проверки сообщений подключаемым модулем, имя которого указано в макросе $RP_NAME$

$RP_CHECKED_MSGS$

Содержит общее число сообщений, проверенных подключаемым модулем, имя которого указано в макросе $RP_NAME$

$RP_CHECKED_SIZE$

Содержит общий размер всех сообщений проверенных подключаемым модулем, имя которого указано в макросе $RP_NAME$

$RP_AGENT_STAT_UUID$

Содержит UUID ключа, который Dr.Web Agent использует для отправки статистики на сервера статистики Dr.Web или серверу централизованной защиты (содержит пустую строку, если данная функция отключена)