<?xml version="1.0"?>

<!--
  Copyright (C) 2006, 2007 Anton Yuzhaninov
  Copyright (C) Nginx, Inc.
  -->

<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">

<module name="Модуль ngx_mail_proxy_module"
        link="/ru/docs/mail/ngx_mail_proxy_module.html"
        lang="ru"
        rev="5">

<section id="directives" name="Директивы">

<!--
<directive name="proxy">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>off</default>
<context>mail</context>
<context>server</context>

<para>
В текущей версии нигде не проверяется.
</para>

</directive>
-->


<directive name="proxy_buffer">
<syntax><value>размер</value></syntax>
<default>4k|8k</default>
<context>mail</context>
<context>server</context>

<para>
Задаёт размер буфера, используемого при проксировании.
По умолчанию размер одного буфера равен размеру страницы.
В зависимости от платформы это или 4K, или 8K.
</para>

</directive>


<directive name="proxy_pass_error_message">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>off</default>
<context>mail</context>
<context>server</context>

<para>
Определяет, передавать ли клиенту сообщение об ошибке,
полученное при аутентификации на бэкенде.
</para>

<para>
Обычно, если аутентификация в nginx прошла успешно,
бэкенд не может вернуть ошибку.
Если же он всё-таки возвращает ошибку,
это значит, что произошла ошибка внутри системы.
В таких случаях сообщение бэкенда может содержать информацию,
которую нельзя показывать клиенту.
Однако для некоторых POP3-серверов ошибка в ответ на правильный пароль
является штатным поведением.
Например, CommuniGatePro извещает пользователя о
<link url="http://www.stalker.com/CommuniGatePro/Alerts.html#Quota">переполнении
ящика</link> или других событиях, периодически выдавая
<link url="http://www.stalker.com/CommuniGatePro/POP.html#Alerts">ошибку
аутентификации</link>.
В этом случае директиву стоит включить.
</para>

</directive>


<directive name="proxy_protocol">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>off</default>
<context>mail</context>
<context>server</context>
<appeared-in>1.19.8</appeared-in>

<para>
Включает
<link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">протокол
PROXY</link> для соединений с бэкендом.
</para>

</directive>


<directive name="proxy_smtp_auth">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>off</default>
<context>mail</context>
<context>server</context>
<appeared-in>1.19.4</appeared-in>

<para>
Разрешает или запрещает аутентификацию пользователей на SMTP-бэкенде
при помощи команды <literal>AUTH</literal>.
</para>

<para>
Если также включён <link id="xclient">XCLIENT</link>,
то команда <literal>XCLIENT</literal> не будет отправлять
параметр <literal>LOGIN</literal>.
</para>

</directive>


<directive name="proxy_timeout">
<syntax><value>время</value></syntax>
<default>24h</default>
<context>mail</context>
<context>server</context>

<para>
Задаёт <value>таймаут</value> между двумя идущими подряд
операциями чтения или записи
на клиентском соединении или соединении с проксируемым сервером.
Если по истечении этого времени данные не передавались,
соединение закрывается.
</para>

</directive>


<directive name="xclient">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>on</default>
<context>mail</context>
<context>server</context>

<para>
Разрешает или запрещает передачу команды
<link url="http://www.postfix.org/XCLIENT_README.html">XCLIENT</link>
с параметрами клиента при подключении к SMTP-бэкенду.
</para>

<para>
При помощи <literal>XCLIENT</literal> MTA может писать в лог
информацию о клиенте и применять различные ограничения на основе этих данных.
</para>

<para>
Если команда <literal>XCLIENT</literal> разрешена,
то при подключении к бэкенду nginx посылает ему следующие команды:
<list type="bullet">
<listitem>
<literal>EHLO</literal>
с <link doc="ngx_mail_core_module.xml" id="server_name">именем сервера</link>
</listitem>

<listitem>
<literal>
XCLIENT
</literal>
</listitem>

<listitem>
<literal>EHLO</literal> или <literal>HELO</literal>,
как её передал клиент
</listitem>
</list>
</para>

<para>
Если <link doc="ngx_mail_core_module.xml" id="resolver">найденное</link>
по IP-адресу клиента имя указывает на тот же адрес,
оно передаётся в параметре <literal>NAME</literal>
команды <literal>XCLIENT</literal>.
Если имя не может быть найдено, указывает на другой адрес,
или не задан <link doc="ngx_mail_core_module.xml" id="resolver"/>,
то в параметре <literal>NAME</literal> передаётся
<literal>[UNAVAILABLE]</literal>.
Если же в процессе поиска имени или адреса произошла ошибка,
передаётся <literal>[TEMPUNAVAIL]</literal>.
</para>

<para>
Если команда <literal>XCLIENT</literal> запрещена,
то при подключении к бэкенду nginx передаёт команду <literal>EHLO</literal> с
<link doc="ngx_mail_core_module.xml" id="server_name">именем сервера</link>,
если клиент передал <literal>EHLO</literal>,
иначе <literal>HELO</literal> с именем сервера.
</para>

</directive>

</section>

</module>