Mercurial > hg > nginx-site

comparison xml/en/docs/mail/ngx_mail_proxy_module.xml @ 966:95c3c3bbf1ce

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Text review.
author Egor Nikitin <yegor.nikitin@gmail.com>
date Wed, 14 Aug 2013 12:03:41 +0400
parents 8e1538faeacb
children b81ad8234f90
comparison
equal deleted inserted replaced
965:fadccc156188 966:95c3c3bbf1ce
34 <default>4k|8k</default> 34 <default>4k|8k</default>
35 <context>mail</context> 35 <context>mail</context>
36 <context>server</context> 36 <context>server</context>
37 37
38 <para> 38 <para>
39 Sets size of the buffer used for proxying. 39 Sets the size of the buffer used for proxying.
40 The buffer size is equal to one memory page by default. 40 By default, the buffer size is equal to one memory page.
41 Depending on a platform, this is either 4K or 8K. 41 Depending on a platform, it is either 4K or 8K.
42 </para> 42 </para>
43 43
44 </directive> 44 </directive>
45 45
46 46
49 <default>off</default> 49 <default>off</default>
50 <context>mail</context> 50 <context>mail</context>
51 <context>server</context> 51 <context>server</context>
52 52
53 <para> 53 <para>
54 Defines whether to pass the error message obtained during 54 Indicates whether to pass the error message obtained during
55 an authentication on the backend to the client. 55 the authentication on the backend to the client.
56 </para> 56 </para>
57 57
58 <para> 58 <para>
59 Usually, if the authentication in nginx was successful, 59 Usually, if the authentication in nginx is a success,
60 backend can’t return an error, but if it nonetheless exists, 60 the backend cannot return an error.
61 this means there is some problem inside. 61 If it nevertheless returns an error,
62 In such cases the backend message can contain the information 62 it means some internal error has occurred.
63 In such case the backend message can contain information
63 that should not be shown to the client. 64 that should not be shown to the client.
64 However responding with an error for the correct password 65 However, responding with an error for the correct password
65 is a normal behavior of some POP3 servers. 66 is a normal behavior for some POP3 servers.
66 For example, CommuniGatePro informs user about 67 For example, CommuniGatePro informs a user about
67 <link url="http://www.stalker.com/CommuniGatePro/Alerts.html#Quota">mailbox 68 <link url="http://www.stalker.com/CommuniGatePro/Alerts.html#Quota">mailbox
68 overflow</link> or other events by periodically outputting the 69 overflow</link> or other events by periodically outputting the
69 <link url="http://www.stalker.com/CommuniGatePro/POP.html#Alerts">authentication 70 <link url="http://www.stalker.com/CommuniGatePro/POP.html#Alerts">authentication
70 error</link>. 71 error</link>.
71 The directive should be enabled in this case. 72 The directive should be enabled in this case.
93 <context>mail</context> 94 <context>mail</context>
94 <context>server</context> 95 <context>server</context>
95 96
96 <para> 97 <para>
97 Enables or disables issuing of the <literal>XCLIENT</literal> command 98 Enables or disables issuing of the <literal>XCLIENT</literal> command
98 upon the connection to the SMTP backend. 99 on connection to the SMTP backend.
99 For the <literal>XCLIENT</literal> command to work it is required to have 100 The <literal>XCLIENT</literal> command requires
100 Postfix with the 101 Postfix with the
101 <link url="http://citrin.ru/nginx:xclient-login-patch">patch</link>, 102 <link url="http://citrin.ru/nginx:xclient-login-patch">patch</link>
102 which adds the <literal>LOGIN</literal> parameter. 103 that adds the <literal>LOGIN</literal> parameter.
103 If the <literal>XCLIENT</literal> command is not used, the MTA will be unable 104 If the <literal>XCLIENT</literal> command is not used, the MTA will be unable
104 to write the client’s 105 to write the client’s
105 <literal>IP</literal>/<literal>HELO</literal>/<literal>LOGIN</literal> 106 <literal>IP</literal>/<literal>HELO</literal>/<literal>LOGIN</literal>
106 to the log and apply various limitations based on this data. 107 to the log and apply various limitations based on this data.
107 </para> 108 </para>
108 109
109 <para> 110 <para>
110 If the <literal>xclient</literal> is enabled, 111 If <literal>xclient</literal> is enabled,
111 then upon a backend connection nginx first issues 112 then on a connection to the backend nginx first issues
112 <example> 113 <example>
113 EHLO server_name 114 EHLO server_name
114 </example> 115 </example>
115 and then 116 and then
116 <example> 117 <example>
117 XCLIENT PROTO=ESMTP HELO=client_hello ADDR=192.168.1.1 LOGIN=good_user NAME=[UNAVAILABLE] 118 XCLIENT PROTO=ESMTP HELO=client_hello ADDR=192.168.1.1 LOGIN=good_user NAME=[UNAVAILABLE]
118 </example> 119 </example>
119 If the client upon a connection to nginx issued the <literal>EHLO</literal>, 120 If the client issues <literal>EHLO</literal> on a connection to nginx,
120 then the <literal>XCLIENT</literal> command will pass 121 the <literal>XCLIENT</literal> command will pass
121 the <literal>PROTO=ESMTP</literal>. 122 <literal>PROTO=ESMTP</literal>.
122 Otherwise, <literal>PROTO=SMTP</literal> will be passed. 123 Otherwise, it will pass <literal>PROTO=SMTP</literal>.
123 The IP address of a client is specified in the <literal>ADDR</literal> 124 The IP address of a client is specified in the <literal>ADDR</literal>
124 parameter, and since nginx does not use DNS to resolve the hostname, 125 parameter, and since nginx does not use DNS to resolve the hostname,
125 the <literal>NAME=[UNAVAILABLE]</literal> is specified. 126 the <literal>NAME=[UNAVAILABLE]</literal> is specified.
126 </para> 127 </para>
127 128
128 <para> 129 <para>
129 If the <literal>xclient</literal> is disabled, 130 If <literal>xclient</literal> is disabled,
130 then the <literal>EHLO</literal> is issued upon the connection to the backend 131 nginx will issue <literal>EHLO</literal> on a connection to the
131 if the client had passed it and the <literal>HELO</literal> 132 backend if the client has passed it, or <literal>HELO</literal>, otherwise.
132 otherwise.
133 </para> 133 </para>
134 134
135 </directive> 135 </directive>
136 136
137 </section> 137 </section>