Mercurial > hg > nginx-site

annotate xml/en/docs/mail/ngx_mail_smtp_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_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"
2737
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
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="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
2737
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
59 <para>
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
60 Plain text authentication methods
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
61 (<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
62 are always enabled,
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
63 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
64 are not specified,
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
65 <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
66 will not be automatically included in <link id="smtp_capabilities"/>.
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
67 </para>
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
68
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
69 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
70
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 <directive name="smtp_capabilities">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
73 <syntax><value>extension</value> ...</syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
74 <default/>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
75 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
76 <context>server</context>
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 Sets the SMTP protocol extensions list
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
80 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
81 <literal>EHLO</literal> command.
1924
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
82 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
83 <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
84 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
85 <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
86 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
87
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
88 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
89 It makes sense to specify the extensions
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
90 supported by the MTA
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
91 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
92 used after the authentication, when nginx transparently proxies the client
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
93 connection to the backend).
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 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 664
diff changeset
97 The current list of standardized extensions is published at
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
98 <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
99 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
100
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
101 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
102
2103
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
103
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
104 <directive name="smtp_client_buffer">
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
105 <syntax><value>size</value></syntax>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
106 <default>4k|8k</default>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
107 <context>mail</context>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
108 <context>server</context>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
109
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
110 <para>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
111 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
112 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
113 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
114 </para>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
115
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
116 </directive>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
117
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
118
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
119 <directive name="smtp_greeting_delay">
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
120 <syntax><value>time</value></syntax>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
121 <default>0</default>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
122 <context>mail</context>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
123 <context>server</context>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
124
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
125 <para>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
126 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
127 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
128 sending SMTP commands.
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
129 </para>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
130
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
131 </directive>
3d2c4bb34e82 Documented smtp_client_buffer and smtp_greeting_delay directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
132
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
133 </section>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
134
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
135 </module>