Mercurial > hg > nginx-site
comparison xml/en/docs/mail/ngx_mail_proxy_module.xml @ 664:8283b1048b27
Translated mail modules into English.
author | Vladimir Homutov <vl@nginx.com> |
---|---|
date | Wed, 05 Sep 2012 14:07:43 +0000 |
parents | |
children | 6726249b66ef |
comparison
equal
deleted
inserted
replaced
663:639bbb0c9d05 | 664:8283b1048b27 |
---|---|
1 <?xml version="1.0"?> | |
2 | |
3 <!-- | |
4 Copyright (C) 2006, 2007 Anton Yuzhaninov | |
5 Copyright (C) Nginx, Inc. | |
6 --> | |
7 | |
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | |
9 | |
10 <module name="Module ngx_mail_proxy_module" | |
11 link="/en/docs/mail/ngx_mail_proxy_module.html" | |
12 lang="en" | |
13 rev="1"> | |
14 | |
15 <section id="directives" name="Directives"> | |
16 | |
17 <!-- | |
18 <directive name="proxy"> | |
19 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
20 <default>off</default> | |
21 <context>mail</context> | |
22 <context>server</context> | |
23 | |
24 <para> | |
25 Does not tested anywhere in the current version. | |
26 </para> | |
27 | |
28 </directive> | |
29 --> | |
30 | |
31 | |
32 <directive name="proxy_buffer"> | |
33 <syntax><value>size</value></syntax> | |
34 <default>4k|8k</default> | |
35 <context>mail</context> | |
36 <context>server</context> | |
37 | |
38 <para> | |
39 Sets size of the buffer used for proxying. | |
40 The buffer size is equal to one memory page by default. | |
41 Depending on a platform, this is either 4K or 8K. | |
42 </para> | |
43 | |
44 </directive> | |
45 | |
46 | |
47 <directive name="proxy_pass_error_message"> | |
48 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
49 <default>off</default> | |
50 <context>mail</context> | |
51 <context>server</context> | |
52 | |
53 <para> | |
54 Defines whether to pass the error message obtained during | |
55 an authentication on the backend to the client. | |
56 </para> | |
57 | |
58 <para> | |
59 Usually, if the authentication in nginx was sucessfull, | |
60 backend can't return an error, but if it nonetheless exists, | |
61 this means there is some problem inside. | |
62 In such cases the backend message can contain the information | |
63 that should not be shown to the client. | |
64 However responding with an error for the correct password | |
65 is a normal behavior of some POP3 servers. | |
66 For example, CommuniGatePro informs user about | |
67 <link url="http://www.stalker.com/CommuniGatePro/Alerts.html#Quota">mailbox | |
68 overflow</link> or other events by periodically outputting the | |
69 <link url="http://www.stalker.com/CommuniGatePro/POP.html#Alerts">authentcation | |
70 error</link>. | |
71 The directive should be enabled in this case. | |
72 </para> | |
73 | |
74 </directive> | |
75 | |
76 | |
77 <directive name="proxy_timeout"> | |
78 <syntax><value>timeout</value></syntax> | |
79 <default>24h</default> | |
80 <context>mail</context> | |
81 <context>server</context> | |
82 | |
83 <para> | |
84 Defines a timeout used after the proxying to the backend had started. | |
85 </para> | |
86 | |
87 </directive> | |
88 | |
89 | |
90 <directive name="xclient"> | |
91 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
92 <default>on</default> | |
93 <context>mail</context> | |
94 <context>server</context> | |
95 | |
96 <para> | |
97 Enables or disables issuing of the <literal>XCLIENT</literal> command | |
98 upon the connection to the SMTP backend. | |
99 For the <literal>XCLIENT</literal> command to work it is required to have | |
100 Postfix with the | |
101 <link url="http://citrin.ru/nginx:xclient-login-patch">patch</link>, | |
102 which adds the <literal>LOGIN</literal> parameter. | |
103 If the <literal>XCLIENT</literal> command is not used, the MTA will be unable | |
104 to write the client's | |
105 <literal>IP</literal>/<literal>HELO</literal>/<literal>LOGIN</literal> | |
106 to the log and apply various limitations based on this data. | |
107 </para> | |
108 | |
109 <para> | |
110 If the <literal>xclient</literal> is enabled, | |
111 then upon a backend connection nginx first issues | |
112 <example> | |
113 EHLO server_name | |
114 </example> | |
115 and then | |
116 <example> | |
117 XCLIENT PROTO=ESMTP HELO=client_hello ADDR=192.168.1.1 LOGIN=good_user NAME=[UNAVAILABLE] | |
118 </example> | |
119 If the client upon a connection to nginx issued the <literal>EHLO</literal>, | |
120 then the <literal>XCLIENT</literal> command will pass | |
121 the <literal>PROTO=ESMTP</literal>. | |
122 Otherwise, <literal>PROTO=SMTP</literal> will be passed. | |
123 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 the <literal>NAME=[UNAVAILABLE]</literal> is specified. | |
126 </para> | |
127 | |
128 <para> | |
129 If the <literal>xclient</literal> is disabled, | |
130 then the <literal>EHLO</literal> is issued upon the connection to the backend | |
131 if the client had passed it and the <literal>HELO</literal> | |
132 otherwise. | |
133 </para> | |
134 | |
135 </directive> | |
136 | |
137 </section> | |
138 | |
139 </module> |