Mercurial > hg > nginx-site
annotate xml/en/docs/mail/ngx_mail_pop3_module.xml @ 3090:27532d42102b
Documented the "rate" parameter of the "error_log" directive.
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Sun, 16 Jun 2024 06:55:30 +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_pop3_module" |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/mail/ngx_mail_pop3_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="6"> |
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="pop3_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 POP3 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 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
28 <tag-name><literal>plain</literal></tag-name> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
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/rfc1939">USER/PASS</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>, |
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
32 <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
|
33 </tag-desc> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
34 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
35 <tag-name><literal>apop</literal></tag-name> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
36 <tag-desc> |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
37 <link url="https://datatracker.ietf.org/doc/html/rfc1939">APOP</link>. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
38 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
|
39 </tag-desc> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
40 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
41 <tag-name><literal>cram-md5</literal></tag-name> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
42 <tag-desc> |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
43 <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
|
44 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
|
45 </tag-desc> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
46 |
1887
9af1e88e10c8
Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents:
966
diff
changeset
|
47 <tag-name><literal>external</literal></tag-name> |
9af1e88e10c8
Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents:
966
diff
changeset
|
48 <tag-desc> |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
49 <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
|
50 </tag-desc> |
9af1e88e10c8
Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents:
966
diff
changeset
|
51 |
3088
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
52 <tag-name><literal>xoauth2</literal></tag-name> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
53 <tag-desc> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
54 <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
|
55 >AUTH XOAUTH2</link> (1.27.1). |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
56 </tag-desc> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
57 |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
58 <tag-name><literal>oauthbearer</literal></tag-name> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
59 <tag-desc> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
60 <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
|
61 >AUTH OAUTHBEARER</link> (1.27.1). |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
62 </tag-desc> |
7b7dbaa7d777
Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2831
diff
changeset
|
63 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
64 </list> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
65 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
66 |
2737
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1924
diff
changeset
|
67 <para> |
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1924
diff
changeset
|
68 Plain text authentication methods |
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1924
diff
changeset
|
69 (<literal>USER/PASS</literal>, <literal>AUTH PLAIN</literal>, |
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1924
diff
changeset
|
70 and <literal>AUTH LOGIN</literal>) are always enabled, |
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1924
diff
changeset
|
71 though if the <literal>plain</literal> method is not specified, |
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1924
diff
changeset
|
72 <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:
1924
diff
changeset
|
73 will not be automatically included in <link id="pop3_capabilities"/>. |
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1924
diff
changeset
|
74 </para> |
9986e1f25cd7
Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1924
diff
changeset
|
75 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
76 </directive> |
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 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
79 <directive name="pop3_capabilities"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
80 <syntax><value>extension</value> ...</syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
81 <default>TOP USER UIDL</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
82 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
83 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
84 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
85 <para> |
966 | 86 Sets the |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
87 <link url="https://datatracker.ietf.org/doc/html/rfc2449">POP3 protocol</link> |
966 | 88 extensions list that is passed to the client in response to |
89 the <literal>CAPA</literal> command. | |
1924
237a10fb98d2
Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
90 The authentication methods specified in the <link id="pop3_auth"/> directive |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
91 (<link url="https://datatracker.ietf.org/doc/html/rfc2449">SASL</link> extension) and |
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2737
diff
changeset
|
92 <link url="https://datatracker.ietf.org/doc/html/rfc2595">STLS</link> |
1924
237a10fb98d2
Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
93 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
|
94 <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
|
95 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
96 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
97 <para> |
966 | 98 It makes sense to specify the extensions |
99 supported by the POP3 backends | |
100 to which the clients are proxied (if these extensions are related to commands | |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
101 used after the authentication, when nginx transparently proxies the client |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
102 connection to the backend). |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
103 </para> |
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> |
966 | 106 The current list of standardized extensions is published at |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
107 <link url="http://www.iana.org/assignments/pop3-extension-mechanism">www.iana.org</link>. |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
108 </para> |
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 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
111 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
112 </section> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
113 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
114 </module> |