annotate xml/ru/docs/mail/ngx_mail_proxy_module.xml @ 641:ca72f350f6f0

mail: - Documented the "imap_auth" directive. - Replaced "authorization" with "authentication". - Changed PLAIN SASL mechanism references to RFC 4616.
author Ruslan Ermilov <ru@nginx.com>
date Thu, 16 Aug 2012 07:19:40 +0000
parents 179336bb5c03
children 95c3c3bbf1ce
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
630
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
3 <!--
638
179336bb5c03 Fixed copyright lines.
Ruslan Ermilov <ru@nginx.com>
parents: 630
diff changeset
4 Copyright (C) 2006, 2007 Anton Yuzhaninov
630
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
5 Copyright (C) Nginx, Inc.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
6 -->
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Модуль ngx_mail_proxy_module"
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/ru/docs/mail/ngx_mail_proxy_module.html"
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
12 lang="ru"
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13 rev="1">
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <section id="directives" name="Директивы">
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 <!--
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 <directive name="proxy">
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 <syntax><literal>on</literal> | <literal>off</literal></syntax>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 <default>off</default>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 <context>mail</context>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 <context>server</context>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 <para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 В текущей версии нигде не проверяется.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 </para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 </directive>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 -->
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 <directive name="proxy_buffer">
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 <syntax><value>размер</value></syntax>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 <default>4k|8k</default>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 <context>mail</context>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 <context>server</context>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 <para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 Задаёт размер буфера, используемого при проксировании.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 По умолчанию размер одного буфера равен размеру страницы.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41 В зависимости от платформы это или 4K, или 8K.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 </para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 </directive>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 <directive name="proxy_pass_error_message">
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 <syntax><literal>on</literal> | <literal>off</literal></syntax>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 <default>off</default>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 <context>mail</context>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 <context>server</context>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 <para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 Определяет, передавать ли клиенту сообщение об ошибке,
641
Ruslan Ermilov <ru@nginx.com>
parents: 638
diff changeset
55 полученное при аутентификации на бэкенде.
630
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 </para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 <para>
641
Ruslan Ermilov <ru@nginx.com>
parents: 638
diff changeset
59 Обычно, если аутентификация в nginx прошла успешно,
630
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 бэкенд не может вернуть ошибку, и если она всё же есть,
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 значит есть какая-то ошибка внутри системы.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 В таких случаях сообщение бэкенда может содержать информацию,
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 которую нельзя показывать клиенту.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 Однако для некоторых POP3-серверов ошибка в ответ на правильный пароль
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 является штатным поведением.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 Например, CommuniGatePro извещает пользователя о
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 <link url="http://www.stalker.com/CommuniGatePro/Alerts.html#Quota">переполнении
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 ящика</link> или других событиях, периодически выдавая
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 <link url="http://www.stalker.com/CommuniGatePro/POP.html#Alerts">ошибку
641
Ruslan Ermilov <ru@nginx.com>
parents: 638
diff changeset
70 аутентификации</link>.
630
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 В этом случае директиву стоит включить.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 </para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 </directive>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 <directive name="proxy_timeout">
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 <syntax><value>время</value></syntax>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79 <default>24h</default>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 <context>mail</context>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 <context>server</context>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 <para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 Задаёт таймаут, который используется после начала проксирования на бэкенд.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 </para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 </directive>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 <directive name="xclient">
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 <syntax><literal>on</literal> | <literal>off</literal></syntax>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 <default>on</default>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 <context>mail</context>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 <context>server</context>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 <para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 Разрешает или запрещает передачу команды <literal>XCLIENT</literal>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98 при подключении к SMTP-бэкенду.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99 Для работы команды <literal>XCLIENT</literal> необходим Postfix с
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 <link url="http://citrin.ru/nginx:xclient-login-patch">патчем</link>,
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 который добавляет параметр <literal>LOGIN</literal>.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 Если не использовать <literal>XCLIENT</literal>, то MTA не сможет писать в лог
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 <literal>IP</literal>/<literal>HELO</literal>/<literal>LOGIN</literal>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 клиента и применять различные ограничения на основе этих данных.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105 </para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107 <para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 Если <literal>xclient</literal> включено,
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 то при подключении к бэкенду nginx сначала передаёт
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110 <example>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 EHLO server_name
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 </example>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 потом
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 <example>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 XCLIENT PROTO=ESMTP HELO=client_hello ADDR=192.168.1.1 LOGIN=good_user NAME=[UNAVAILABLE]
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 </example>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 Если клиент при подключении к nginx передал <literal>EHLO</literal>, то в
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118 команде <literal>XCLIENT</literal> передаётся <literal>PROTO=ESMTP</literal>.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 В противном случае передаётся <literal>PROTO=SMTP</literal>.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 В параметре <literal>ADDR</literal> указывается IP-адрес клиента,
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 а поскольку nginx не обращается к DNS для получения имени хоста,
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122 то указывается <literal>NAME=[UNAVAILABLE]</literal>.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 </para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 <para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126 Если же <literal>xclient</literal> выключено,
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127 то при подключении к бэкенду nginx передаёт
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 <literal>EHLO</literal>, если его передал клиент,
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
129 и <literal>HELO</literal> в остальных случаях.
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
130 </para>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132 </directive>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
133
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134 </section>
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
135
a235ce0f8eef Initial mail proxy server documentation in Russian.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
136 </module>