<?xml version="1.0"?>

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

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

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

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

<directive name="pop3_auth">
<syntax><value>метод</value> ...</syntax>
<default>plain</default>
<context>mail</context>
<context>server</context>

<para>
Задаёт разрешённые методы аутентификации POP3-клиентов.
Поддерживаемые методы:
<list type="tag">

<tag-name><literal>plain</literal></tag-name>
<tag-desc>
<link url="https://tools.ietf.org/html/rfc1939">USER/PASS</link>,
<link url="https://tools.ietf.org/html/rfc4616">AUTH PLAIN</link>,
<link url="https://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link>
</tag-desc>

<tag-name><literal>apop</literal></tag-name>
<tag-desc>
<link url="https://tools.ietf.org/html/rfc1939">APOP</link>.
Для работы этого метода пароль должен храниться в незашифрованном виде.
</tag-desc>

<tag-name><literal>cram-md5</literal></tag-name>
<tag-desc>
<link url="https://tools.ietf.org/html/rfc2195">AUTH CRAM-MD5</link>.
Для работы этого метода пароль должен храниться в незашифрованном виде.
</tag-desc>

<tag-name><literal>external</literal></tag-name>
<tag-desc>
<link url="https://tools.ietf.org/html/rfc4422">AUTH EXTERNAL</link> (1.11.6).
</tag-desc>

</list>
</para>

<para>
Методы аутентификации с передачей пароля открытым текстом
(<literal>USER/PASS</literal>, <literal>AUTH PLAIN</literal>
и <literal>AUTH LOGIN</literal>) включены всегда,
однако если метод <literal>plain</literal> не указан, то
<literal>AUTH PLAIN</literal> и <literal>AUTH LOGIN</literal>
не будут автоматически добавляться в <link id="pop3_capabilities"/>.
</para>

</directive>


<directive name="pop3_capabilities">
<syntax><value>расширение</value> ...</syntax>
<default>TOP USER UIDL</default>
<context>mail</context>
<context>server</context>

<para>
Позволяет указать список расширений
<link url="https://tools.ietf.org/html/rfc2449">протокола POP3</link>,
выдаваемый клиенту по команде
<literal>CAPA</literal>.
В зависимости от значения директивы
<link doc="ngx_mail_ssl_module.xml" id="starttls"/>
к этому списку автоматически добавляются
методы аутентификации, указанные в директиве <link id="pop3_auth"/>
(расширение <link url="https://tools.ietf.org/html/rfc2449">SASL</link>), и
<link url="https://tools.ietf.org/html/rfc2595">STLS</link>.
</para>

<para>
В данной директиве имеет смысл указать расширения,
поддерживаемые POP3-бэкендами,
на которые проксируются клиенты (если эти расширения относятся к командам,
используемым после аутентификации, когда nginx прозрачно проксирует подключение
клиента на бэкенд).
</para>

<para>
Текущий список стандартизованных расширений опубликован на
<link url="http://www.iana.org/assignments/pop3-extension-mechanism">www.iana.org</link>.
</para>

</directive>

</section>

</module>