Mercurial > hg > nginx-site

annotate xml/en/docs/mail/ngx_mail_smtp_module.xml @ 2736:48004177276d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Reordered methods in imap_auth and smtp_auth. The "LOGIN" SASL mechanism is obsolete and expected to be only used for compatibility. Accordingly, the corresponding "login" method is now listed after the "plain" method.
author Maxim Dounin <mdounin@mdounin.ru>
date Thu, 10 Jun 2021 18:34:32 +0300
parents 3d2c4bb34e82
children 9986e1f25cd7
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_smtp_module"
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
11 link="/en/docs/mail/ngx_mail_smtp_module.html"
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
12 lang="en"
2736
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2103
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="smtp_auth">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
18 <syntax><value>method</value> ...</syntax>
2736
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2103
diff changeset
19 <default>plain login</default>
664
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
1923
66a30a380fba Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents: 1887
diff changeset
25 <link url="https://tools.ietf.org/html/rfc2554">SASL authentication</link>
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
26 for SMTP clients.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
27 Supported methods are:
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
28 <list type="tag">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
29
2736
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2103
diff changeset
30 <tag-name><literal>plain</literal></tag-name>
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2103
diff changeset
31 <tag-desc>
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2103
diff changeset
32 <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: 2103
diff changeset
33 </tag-desc>
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2103
diff changeset
34
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
35 <tag-name><literal>login</literal></tag-name>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
36 <tag-desc>
1923
66a30a380fba Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents: 1887
diff changeset
37 <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
38 </tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
39
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
40 <tag-name><literal>cram-md5</literal></tag-name>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
41 <tag-desc>
1923
66a30a380fba Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents: 1887
diff changeset
42 <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
43 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
44 </tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
45
1887
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1065
diff changeset
46 <tag-name><literal>external</literal></tag-name>
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1065
diff changeset
47 <tag-desc>
1923
66a30a380fba Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents: 1887
diff changeset
48 <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: 1065
diff changeset
49 </tag-desc>
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1065
diff changeset
50
1065
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 966
diff changeset
51 <tag-name><literal>none</literal></tag-name>
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 966
diff changeset
52 <tag-desc>
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 966
diff changeset
53 Authentication is not required.
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 966
diff changeset
54 </tag-desc>
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 966
diff changeset
55
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
56 </list>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
57 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
58
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
59 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
60
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
61
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
62 <directive name="smtp_capabilities">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
63 <syntax><value>extension</value> ...</syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
64 <default/>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
65 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
66 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
67
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
68 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
69 Sets the SMTP protocol extensions list
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
70 that is passed to the client in response to the
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
71 <literal>EHLO</literal> command.
1924
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
72 The authentication methods specified in the <link id="smtp_auth"/> directive and
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
73 <link url="https://tools.ietf.org/html/rfc3207">STARTTLS</link>
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
74 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
75 <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
76 </para>
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 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
79 It makes sense to specify the extensions
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
80 supported by the MTA
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
81 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
82 used after the authentication, when nginx transparently proxies the client
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
83 connection to the backend).
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
84 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
85
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
86 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
87 The current list of standardized extensions is published at
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
88 <link url="http://www.iana.org/assignments/mail-parameters">www.iana.org</link>.
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 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
92
2103
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
93
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
94 <directive name="smtp_client_buffer">
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
95 <syntax><value>size</value></syntax>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
96 <default>4k|8k</default>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
97 <context>mail</context>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
98 <context>server</context>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
99
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
100 <para>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
101 Sets the <value>size</value> of the buffer used for reading SMTP commands.
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
102 By default, the buffer size is equal to one memory page.
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
103 This is either 4K or 8K, depending on a platform.
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
104 </para>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
105
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
106 </directive>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
107
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
108
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
109 <directive name="smtp_greeting_delay">
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
110 <syntax><value>time</value></syntax>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
111 <default>0</default>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
112 <context>mail</context>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
113 <context>server</context>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
114
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
115 <para>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
116 Allows setting a delay before sending an SMTP greeting
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
117 in order to reject clients who fail to wait for the greeting before
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
118 sending SMTP commands.
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
119 </para>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
120
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
121 </directive>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
122
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
123 </section>
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 </module>