Mercurial > hg > nginx-site
view xml/en/docs/mail/ngx_mail_imap_module.xml @ 1826:da6a3e401b26
Slightly reformatted the error_page description.
Information about directives inheritance was moved to the end.
Blocks describing various syntaxes of the "uri" argument were
put in the following order:
- internal redirect to the specified /uri;
- internal redirect to a named location;
- URL redirection.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Mon, 24 Oct 2016 11:57:46 +0300 |
parents | 95c3c3bbf1ce |
children | 9af1e88e10c8 |
line wrap: on
line source
<?xml version="1.0"?> <!-- Copyright (C) 2006, 2007 Anton Yuzhaninov Copyright (C) Nginx, Inc. --> <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> <module name="Module ngx_mail_imap_module" link="/en/docs/mail/ngx_mail_imap_module.html" lang="en" rev="1"> <section id="directives" name="Directives"> <directive name="imap_auth"> <syntax><value>method</value> ...</syntax> <default>plain</default> <context>mail</context> <context>server</context> <para> Sets permitted methods of authentication for IMAP clients. Supported methods are: <list type="tag"> <tag-name><literal>login</literal></tag-name> <tag-desc> <link url="http://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH=LOGIN</link> </tag-desc> <tag-name><literal>plain</literal></tag-name> <tag-desc> <link url="http://tools.ietf.org/html/rfc4616">AUTH=PLAIN</link> </tag-desc> <tag-name><literal>cram-md5</literal></tag-name> <tag-desc> <link url="http://tools.ietf.org/html/rfc2195">AUTH=CRAM-MD5</link>. In order for this method to work, the password must be stored unencrypted. </tag-desc> </list> </para> </directive> <directive name="imap_capabilities"> <syntax><value>extension</value> ...</syntax> <default>IMAP4 IMAP4rev1 UIDPLUS</default> <context>mail</context> <context>server</context> <para> Sets the <link url="http://tools.ietf.org/html/rfc3501">IMAP protocol</link> extensions list that is passed to the client in response to the <literal>CAPABILITY</literal> command. The authentication methods specified in the <link id="imap_auth"/> and <link url="http://tools.ietf.org/html/rfc2595">STARTTLS</link> directives are automatically added to this list if the <link doc="ngx_mail_ssl_module.xml" id="starttls"/> directive is enabled. </para> <para> It makes sense to specify the extensions supported by the IMAP backends to which the clients are proxied (if these extensions are related to commands used after the authentication, when nginx transparently proxies a client connection to the backend). </para> <para> The current list of standardized extensions is published at <link url="http://www.iana.org/assignments/imap4-capabilities">www.iana.org</link>. </para> </directive> <directive name="imap_client_buffer"> <syntax><value>size</value></syntax> <default>4k|8k</default> <context>mail</context> <context>server</context> <para> Sets the IMAP commands read buffer size. By default, the buffer size is equal to one memory page. This is either 4K or 8K, depending on a platform. </para> </directive> </section> </module>