comparison xml/ru/docs/mail/ngx_mail_core_module.xml @ 637:9a85069172dc

IMAP/POP3/SMTP directives split into their own modules.
author Ruslan Ermilov <ru@nginx.com>
date Thu, 16 Aug 2012 05:04:04 +0000
parents 310872ba13ae
children 179336bb5c03
comparison
equal deleted inserted replaced
636:310872ba13ae 637:9a85069172dc
69 69
70 </section> 70 </section>
71 71
72 72
73 <section id="directives" name="Директивы"> 73 <section id="directives" name="Директивы">
74
75 <directive name="imap_capabilities">
76 <syntax><value>расширение</value> ...</syntax>
77 <default>IMAP4 IMAP4rev1 UIDPLUS</default>
78 <context>mail</context>
79 <context>server</context>
80
81 <para>
82 Позволяет указать список расширений
83 <link url="http://tools.ietf.org/html/rfc3501">протокола IMAP</link>,
84 выдаваемый клиенту по команде
85 <literal>CAPABILITY</literal>.
86 К этому списку автоматически добавляется
87 <link url="http://tools.ietf.org/html/rfc2595">STARTTLS</link>,
88 если включена директива <link doc="ngx_mail_ssl_module.xml" id="starttls"/>.
89 </para>
90
91 <para>
92 В данной директиве имеет смысл указать расширения,
93 поддерживаемые IMAP-бэкендами,
94 на которые проксируются клиенты (если эти расширения относятся к командам,
95 используемым после авторизации, когда nginx прозрачно проксирует подключение
96 клиента на бэкенд).
97 </para>
98
99 <para>
100 Текущий список стандартизованных расширений опубликован на
101 <link url="http://www.iana.org/assignments/imap4-capabilities">www.iana.org</link>.
102 </para>
103
104 </directive>
105
106
107 <directive name="imap_client_buffer">
108 <syntax><value>размер</value></syntax>
109 <default>4k|8k</default>
110 <context>mail</context>
111 <context>server</context>
112
113 <para>
114 Задаёт размер буфера для чтения IMAP-команд.
115 По умолчанию размер одного буфера равен размеру страницы.
116 В зависимости от платформы это или 4K, или 8K.
117 </para>
118
119 </directive>
120
121 74
122 <directive name="listen"> 75 <directive name="listen">
123 <syntax> 76 <syntax>
124 <value>адрес</value>:<value>порт</value> 77 <value>адрес</value>:<value>порт</value>
125 [<literal>bind</literal>]</syntax> 78 [<literal>bind</literal>]</syntax>
159 </para> 112 </para>
160 113
161 </directive> 114 </directive>
162 115
163 116
164 <directive name="pop3_auth">
165 <syntax><value>метод</value> ...</syntax>
166 <default>plain</default>
167 <context>mail</context>
168 <context>server</context>
169
170 <para>
171 Задаёт разрешённые методы аутентификации POP3-клиентов.
172 Поддерживаемые методы:
173 <list type="tag">
174
175 <tag-name><literal>plain</literal></tag-name>
176 <tag-desc>
177 <link url="http://tools.ietf.org/html/rfc1939">USER/PASS</link>,
178 <link url="http://tools.ietf.org/html/rfc2595">AUTH PLAIN</link>,
179 <link url="http://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link>.
180 Данные методы отключить нельзя.
181 </tag-desc>
182
183 <tag-name><literal>apop</literal></tag-name>
184 <tag-desc>
185 <link url="http://tools.ietf.org/html/rfc1939">APOP</link>.
186 Для работы этого метода пароль должен храниться в незашифрованном виде.
187 </tag-desc>
188
189 <tag-name><literal>cram-md5</literal></tag-name>
190 <tag-desc>
191 <link url="http://tools.ietf.org/html/rfc2195">AUTH CRAM-MD5</link>.
192 Для работы этого метода пароль должен храниться в незашифрованном виде.
193 </tag-desc>
194
195 </list>
196 </para>
197
198 </directive>
199
200
201 <directive name="pop3_capabilities">
202 <syntax><value>расширение</value> ...</syntax>
203 <default>TOP USER UIDL</default>
204 <context>mail</context>
205 <context>server</context>
206
207 <para>
208 Позволяет указать список расширений
209 <link url="http://tools.ietf.org/html/rfc2449">протокола POP3</link>,
210 выдаваемый клиенту по команде
211 <literal>CAPA</literal>.
212 К этому списку автоматически добавляются
213 методы авторизации, указанные в директиве <link id="pop3_auth"/>
214 (расширение <link url="http://tools.ietf.org/html/rfc2449">SASL</link>) и
215 <link url="http://tools.ietf.org/html/rfc2595">STLS</link>,
216 если включена директива <link doc="ngx_mail_ssl_module.xml" id="starttls"/>.
217 </para>
218
219 <para>
220 В данной директиве имеет смысл указать расширения,
221 поддерживаемые POP3-бэкендами,
222 на которые проксируются клиенты (если эти расширения относятся к командам,
223 используемым после авторизации, когда nginx прозрачно проксирует подключение
224 клиента на бэкенд).
225 </para>
226
227 <para>
228 Текущий список стандартизованных расширений опубликован на
229 <link url="http://www.iana.org/assignments/pop3-extension-mechanism">www.iana.org</link>.
230 </para>
231
232 </directive>
233
234
235 <directive name="protocol"> 117 <directive name="protocol">
236 <syntax> 118 <syntax>
237 <literal>imap</literal> | 119 <literal>imap</literal> |
238 <literal>pop3</literal> | 120 <literal>pop3</literal> |
239 <literal>smtp</literal></syntax> 121 <literal>smtp</literal></syntax>
240 <default/> 122 <default/>
241 <context>server</context> 123 <context>server</context>
242 124
243 <para> 125 <para>
126 Задаёт протокол проксируемого сервера.
127 Возможные протоколы:
128 <link doc="ngx_mail_imap_module.xml">IMAP</link>,
129 <link doc="ngx_mail_pop3_module.xml">POP3</link> и
130 <link doc="ngx_mail_smtp_module.xml">SMTP</link>.
244 </para> 131 </para>
245 132
246 </directive> 133 </directive>
247 134
248 135
282 если включена команда <link doc="ngx_mail_proxy_module.xml" id="xclient"/>. 169 если включена команда <link doc="ngx_mail_proxy_module.xml" id="xclient"/>.
283 </listitem> 170 </listitem>
284 171
285 </list> 172 </list>
286 173
287 </para>
288
289 </directive>
290
291
292 <directive name="smtp_auth">
293 <syntax><value>метод</value> ...</syntax>
294 <default>login plain</default>
295 <context>mail</context>
296 <context>server</context>
297
298 <para>
299 Задаёт разрешённые методы
300 <link url="http://tools.ietf.org/html/rfc2554">SASL-аутентификации</link>
301 SMTP-клиентов.
302 Поддерживаемые методы:
303 <list type="tag">
304
305 <tag-name><literal>login</literal></tag-name>
306 <tag-desc>
307 <link url="http://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link>
308 </tag-desc>
309
310 <tag-name><literal>plain</literal></tag-name>
311 <tag-desc>
312 <link url="http://tools.ietf.org/html/rfc2595">AUTH PLAIN</link>
313 </tag-desc>
314
315 <tag-name><literal>cram-md5</literal></tag-name>
316 <tag-desc>
317 <link url="http://tools.ietf.org/html/rfc2195">AUTH CRAM-MD5</link>.
318 Для работы этого метода пароль должен храниться в незашифрованном виде.
319 </tag-desc>
320
321 </list>
322 </para>
323
324 </directive>
325
326
327 <directive name="smtp_capabilities">
328 <syntax><value>расширение</value> ...</syntax>
329 <default/>
330 <context>mail</context>
331 <context>server</context>
332
333 <para>
334 Позволяет указать список расширений протокола SMTP,
335 выдаваемый клиенту в ответе на команду
336 <literal>EHLO</literal>.
337 К этому списку автоматически добавляются
338 методы авторизации, указанные в директиве <link id="smtp_auth"/>.
339 </para>
340
341 <para>
342 В данной директиве имеет смысл указать расширения,
343 поддерживаемые MTA,
344 на который проксируются клиенты (если эти расширения относятся к командам,
345 используемым после авторизации, когда nginx прозрачно проксирует подключение
346 клиента на бэкенд).
347 </para>
348
349 <para>
350 Текущий список стандартизованных расширений опубликован на
351 <link url="http://www.iana.org/assignments/mail-parameters">www.iana.org</link>.
352 </para> 174 </para>
353 175
354 </directive> 176 </directive>
355 177
356 178