Mercurial > hg > nginx-site

annotate xml/en/docs/mail/ngx_mail_imap_module.xml @ 2769:16f6fa718be2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated TLSv1.3 support notes. Previous notes described some early development snapshot of OpenSSL 1.1.1 with disabled TLSv1.3 by default. It was then enabled in the first alpha. Further, the updated text covers later major releases such as OpenSSL 3.0.
author Sergey Kandaurov <pluknet@nginx.com>
date Thu, 30 Sep 2021 16:29:20 +0300
parents 9986e1f25cd7
children 4add6ae1296f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
2
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
3 <!--
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
4 Copyright (C) 2006, 2007 Anton Yuzhaninov
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
5 Copyright (C) Nginx, Inc.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
6 -->
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
7
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
9
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_mail_imap_module"
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
11 link="/en/docs/mail/ngx_mail_imap_module.html"
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
12 lang="en"
2737
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
13 rev="7">
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
14
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
15 <section id="directives" name="Directives">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
16
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
17 <directive name="imap_auth">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
18 <syntax><value>method</value> ...</syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
19 <default>plain</default>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
20 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
21 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
22
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
23 <para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
24 Sets permitted methods of authentication for IMAP clients.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
25 Supported methods are:
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
26 <list type="tag">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
27
2736
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2102
diff changeset
28 <tag-name><literal>plain</literal></tag-name>
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2102
diff changeset
29 <tag-desc>
2737
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
30 <link url="https://tools.ietf.org/html/rfc3501">LOGIN</link>,
2736
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2102
diff changeset
31 <link url="https://tools.ietf.org/html/rfc4616">AUTH=PLAIN</link>
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2102
diff changeset
32 </tag-desc>
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2102
diff changeset
33
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
34 <tag-name><literal>login</literal></tag-name>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
35 <tag-desc>
1923
66a30a380fba Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents: 1887
diff changeset
36 <link url="https://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH=LOGIN</link>
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
37 </tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
38
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
39 <tag-name><literal>cram-md5</literal></tag-name>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
40 <tag-desc>
1923
66a30a380fba Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents: 1887
diff changeset
41 <link url="https://tools.ietf.org/html/rfc2195">AUTH=CRAM-MD5</link>.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
42 In order for this method to work, the password must be stored unencrypted.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
43 </tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
44
1887
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 966
diff changeset
45 <tag-name><literal>external</literal></tag-name>
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 966
diff changeset
46 <tag-desc>
1923
66a30a380fba Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents: 1887
diff changeset
47 <link url="https://tools.ietf.org/html/rfc4422">AUTH=EXTERNAL</link> (1.11.6).
1887
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 966
diff changeset
48 </tag-desc>
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 966
diff changeset
49
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
50 </list>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
51 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
52
2737
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
53 <para>
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
54 Plain text authentication methods
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
55 (the <literal>LOGIN</literal> command, <literal>AUTH=PLAIN</literal>,
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
56 and <literal>AUTH=LOGIN</literal>) are always enabled,
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
57 though if the <literal>plain</literal> and <literal>login</literal> methods
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
58 are not specified,
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
59 <literal>AUTH=PLAIN</literal> and <literal>AUTH=LOGIN</literal>
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
60 will not be automatically included in <link id="imap_capabilities"/>.
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
61 </para>
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
62
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
63 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
64
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
65
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
66 <directive name="imap_capabilities">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
67 <syntax><value>extension</value> ...</syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
68 <default>IMAP4 IMAP4rev1 UIDPLUS</default>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
69 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
70 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
71
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
72 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
73 Sets the
1923
66a30a380fba Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents: 1887
diff changeset
74 <link url="https://tools.ietf.org/html/rfc3501">IMAP protocol</link>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
75 extensions list that is passed to the client in response to
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
76 the <literal>CAPABILITY</literal> command.
1924
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
77 The authentication methods specified in the <link id="imap_auth"/> directive and
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
78 <link url="https://tools.ietf.org/html/rfc2595">STARTTLS</link>
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
79 are automatically added to this list depending on the
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
80 <link doc="ngx_mail_ssl_module.xml" id="starttls"/> directive value.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
81 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
82
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
83 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
84 It makes sense to specify the extensions
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
85 supported by the IMAP backends
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
86 to which the clients are proxied (if these extensions are related to commands
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
87 used after the authentication, when nginx transparently proxies a client
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
88 connection to the backend).
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
89 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
90
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
91 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
92 The current list of standardized extensions is published at
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
93 <link url="http://www.iana.org/assignments/imap4-capabilities">www.iana.org</link>.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
94 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
95
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
96 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
97
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
98
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
99 <directive name="imap_client_buffer">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
100 <syntax><value>size</value></syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
101 <default>4k|8k</default>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
102 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
103 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
104
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
105 <para>
2102
d7f34859645b Matched wording of imap_client_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
106 Sets the <value>size</value> of the buffer used for reading IMAP commands.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
107 By default, the buffer size is equal to one memory page.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
108 This is either 4K or 8K, depending on a platform.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
109 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
110
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
111 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
112
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
113 </section>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
114
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
115 </module>