ngx_mail_imap_module.xml

<?xml version="1.0"?>

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

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

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

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

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

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

<tag-name><literal>plain</literal></tag-name>
<tag-desc>
<link url="https://datatracker.ietf.org/doc/html/rfc3501">LOGIN</link>,
<link url="https://datatracker.ietf.org/doc/html/rfc4616">AUTH=PLAIN</link>
</tag-desc>

<tag-name><literal>login</literal></tag-name>
<tag-desc>
<link url="https://datatracker.ietf.org/doc/html/draft-murchison-sasl-login-00">AUTH=LOGIN</link>
</tag-desc>

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

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

</list>
</para>

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

</directive>


<directive name="imap_capabilities">
<syntax><value>расширение</value> ...</syntax>
<default>IMAP4 IMAP4rev1 UIDPLUS</default>
<context>mail</context>
<context>server</context>

<para>
Позволяет указать список расширений
<link url="https://datatracker.ietf.org/doc/html/rfc3501">протокола IMAP</link>,
выдаваемый клиенту по команде
<literal>CAPABILITY</literal>.
В зависимости от значения директивы
<link doc="ngx_mail_ssl_module.xml" id="starttls"/>
к этому списку автоматически добавляются
методы аутентификации, указанные в директиве <link id="imap_auth"/>, и
<link url="https://datatracker.ietf.org/doc/html/rfc2595">STARTTLS</link>.
</para>

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

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

</directive>


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

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

</directive>

</section>

</module>