Mercurial > hg > nginx-site
annotate xml/en/docs/mail/ngx_mail_imap_module.xml @ 3094:f7e9bd7de0f9 default tip
freenginx-1.27.3
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Tue, 13 Aug 2024 17:45:23 +0300 |
parents | 7b7dbaa7d777 |
children |
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" |
3088
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
13 rev="8"> |
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> |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
30 <link url="https://datatracker.ietf.org/doc/html/rfc3501">LOGIN</link>, |
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
31 <link url="https://datatracker.ietf.org/doc/html/rfc4616">AUTH=PLAIN</link> |
2736
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> |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
36 <link url="https://datatracker.ietf.org/doc/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> |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
41 <link url="https://datatracker.ietf.org/doc/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> |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
47 <link url="https://datatracker.ietf.org/doc/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 |
3088
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
50 <tag-name><literal>xoauth2</literal></tag-name> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
51 <tag-desc> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
52 <link url="https://developers.google.com/gmail/imap/xoauth2-protocol" |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
53 >AUTH=XOAUTH2</link> (1.27.1). |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
54 </tag-desc> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
55 |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
56 <tag-name><literal>oauthbearer</literal></tag-name> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
57 <tag-desc> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
58 <link url="https://datatracker.ietf.org/doc/html/rfc7628" |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
59 >AUTH=OAUTHBEARER</link> (1.27.1). |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
60 </tag-desc> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
61 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
62 </list> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
63 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
64 |
2737
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2736
diff
changeset
|
65 <para> |
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2736
diff
changeset
|
66 Plain text authentication methods |
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2736
diff
changeset
|
67 (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
|
68 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
|
69 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
|
70 are not specified, |
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2736
diff
changeset
|
71 <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
|
72 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
|
73 </para> |
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2736
diff
changeset
|
74 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
75 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
76 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
77 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
78 <directive name="imap_capabilities"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
79 <syntax><value>extension</value> ...</syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
80 <default>IMAP4 IMAP4rev1 UIDPLUS</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
81 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
82 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
83 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
84 <para> |
966 | 85 Sets the |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
86 <link url="https://datatracker.ietf.org/doc/html/rfc3501">IMAP protocol</link> |
966 | 87 extensions list that is passed to the client in response to |
88 the <literal>CAPABILITY</literal> command. | |
1924
237a10fb98d2
Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
89 The authentication methods specified in the <link id="imap_auth"/> directive and |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
90 <link url="https://datatracker.ietf.org/doc/html/rfc2595">STARTTLS</link> |
1924
237a10fb98d2
Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
91 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
|
92 <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
|
93 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
94 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
95 <para> |
966 | 96 It makes sense to specify the extensions |
97 supported by the IMAP backends | |
98 to which the clients are proxied (if these extensions are related to commands | |
99 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
|
100 connection to the backend). |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
101 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
102 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
103 <para> |
966 | 104 The current list of standardized extensions is published at |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
105 <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
|
106 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
107 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
108 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
109 |
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 name="imap_client_buffer"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
112 <syntax><value>size</value></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
113 <default>4k|8k</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
114 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
115 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
116 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
117 <para> |
2102
d7f34859645b
Matched wording of imap_client_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1924
diff
changeset
|
118 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
|
119 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
|
120 This is either 4K or 8K, depending on a platform. |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
121 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
122 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
123 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
124 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
125 </section> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
126 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
127 </module> |