Mercurial > hg > nginx-site
annotate xml/en/docs/mail/ngx_mail_proxy_module.xml @ 2902:843bf979dcaa
Added s.sendDownstream and s.sendUpstream to njs reference.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Fri, 21 Oct 2022 12:20:28 +0100 |
parents | a4d3e6db81b9 |
children | 7ebe15d6c68d |
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_proxy_module" |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/mail/ngx_mail_proxy_module.html" |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
12 lang="en" |
2678
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
13 rev="5"> |
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 <!-- |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
18 <directive name="proxy"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
19 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
20 <default>off</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
21 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
22 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
23 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
24 <para> |
1046 | 25 Not tested anywhere in the current version. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
26 </para> |
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 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
29 --> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
30 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
31 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
32 <directive name="proxy_buffer"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
33 <syntax><value>size</value></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
34 <default>4k|8k</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
35 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
36 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
37 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
38 <para> |
966 | 39 Sets the size of the buffer used for proxying. |
40 By default, the buffer size is equal to one memory page. | |
41 Depending on a platform, it is either 4K or 8K. | |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
42 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
43 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
44 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
45 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
46 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
47 <directive name="proxy_pass_error_message"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
48 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
49 <default>off</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
50 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
51 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
52 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
53 <para> |
966 | 54 Indicates whether to pass the error message obtained during |
55 the authentication on the backend to the client. | |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
56 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
57 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
58 <para> |
966 | 59 Usually, if the authentication in nginx is a success, |
60 the backend cannot return an error. | |
61 If it nevertheless returns an error, | |
62 it means some internal error has occurred. | |
63 In such case the backend message can contain information | |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
64 that should not be shown to the client. |
966 | 65 However, responding with an error for the correct password |
66 is a normal behavior for some POP3 servers. | |
67 For example, CommuniGatePro informs a user about | |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
68 <link url="http://www.stalker.com/CommuniGatePro/Alerts.html#Quota">mailbox |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
69 overflow</link> or other events by periodically outputting the |
668 | 70 <link url="http://www.stalker.com/CommuniGatePro/POP.html#Alerts">authentication |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
71 error</link>. |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
72 The directive should be enabled in this case. |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
73 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
74 |
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 |
2678
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
78 <directive name="proxy_protocol"> |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
79 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
80 <default>off</default> |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
81 <context>mail</context> |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
82 <context>server</context> |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
83 <appeared-in>1.19.8</appeared-in> |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
84 |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
85 <para> |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
86 Enables the |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
87 <link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">PROXY |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
88 protocol</link> for connections to a backend. |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
89 </para> |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
90 |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
91 </directive> |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
92 |
a4d3e6db81b9
Documented the "proxy_protocol" directive in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2614
diff
changeset
|
93 |
2614
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
94 <directive name="proxy_smtp_auth"> |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
95 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
96 <default>off</default> |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
97 <context>mail</context> |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
98 <context>server</context> |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
99 <appeared-in>1.19.4</appeared-in> |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
100 |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
101 <para> |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
102 Enables or disables user authentication on the SMTP backend |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
103 using the <literal>AUTH</literal> command. |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
104 </para> |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
105 |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
106 <para> |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
107 If <link id="xclient">XCLIENT</link> is also enabled, |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
108 then the <literal>XCLIENT</literal> command will not send |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
109 the <literal>LOGIN</literal> parameter. |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
110 </para> |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
111 |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
112 </directive> |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
113 |
1f8f12a32ecd
Documented the proxy_smtp_auth directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1526
diff
changeset
|
114 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
115 <directive name="proxy_timeout"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
116 <syntax><value>timeout</value></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
117 <default>24h</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
118 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
119 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
120 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
121 <para> |
1526
7b15698cbdb7
Updated the proxy_timeout directive for mail and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1070
diff
changeset
|
122 Sets the <value>timeout</value> between two successive |
7b15698cbdb7
Updated the proxy_timeout directive for mail and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1070
diff
changeset
|
123 read or write operations on client or proxied server connections. |
7b15698cbdb7
Updated the proxy_timeout directive for mail and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1070
diff
changeset
|
124 If no data is transmitted within this time, the connection is closed. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
125 </para> |
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 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
128 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
129 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
130 <directive name="xclient"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
131 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
132 <default>on</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
133 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
134 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
135 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
136 <para> |
1070
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
137 Enables or disables the passing of the |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
138 <link url="http://www.postfix.org/XCLIENT_README.html">XCLIENT</link> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
139 command with client parameters when connecting to the SMTP backend. |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
140 </para> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
141 |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
142 <para> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
143 With <literal>XCLIENT</literal>, the MTA is able to write client information |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
144 to the log and apply various limitations based on this data. |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
145 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
146 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
147 <para> |
1070
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
148 If <literal>XCLIENT</literal> is enabled |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
149 then nginx passes the following commands when connecting to the backend: |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
150 <list type="bullet"> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
151 <listitem> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
152 <literal>EHLO</literal> with the |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
153 <link doc="ngx_mail_core_module.xml" id="server_name">server name</link> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
154 </listitem> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
155 |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
156 <listitem> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
157 <literal> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
158 XCLIENT |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
159 </literal> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
160 </listitem> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
161 |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
162 <listitem> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
163 <literal>EHLO</literal> or <literal>HELO</literal>, |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
164 as passed by the client |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
165 </listitem> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
166 </list> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
167 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
168 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
169 <para> |
1070
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
170 If the name |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
171 <link doc="ngx_mail_core_module.xml" id="resolver">found</link> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
172 by the client IP address points to the same address, |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
173 it is passed in the <literal>NAME</literal> parameter |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
174 of the <literal>XCLIENT</literal> command. |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
175 If the name could not be found, points to a different address, |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
176 or <link doc="ngx_mail_core_module.xml" id="resolver"/> is not specified, |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
177 the <literal>[UNAVAILABLE]</literal> is passed |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
178 in the <literal>NAME</literal> parameter. |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
179 If an error has occurred in the process of resolving, |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
180 the <literal>[TEMPUNAVAIL]</literal> value is used. |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
181 </para> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
182 |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
183 <para> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
184 If <literal>XCLIENT</literal> is disabled |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
185 then nginx passes the <literal>EHLO</literal> command with the |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
186 <link doc="ngx_mail_core_module.xml" id="server_name">server name</link> |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
187 when connecting to the backend if the client has passed |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
188 <literal>EHLO</literal>, |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
189 or <literal>HELO</literal> with the server name, otherwise. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
190 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
191 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
192 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
193 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
194 </section> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
195 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
196 </module> |