Mercurial > hg > nginx-site

comparison xml/en/docs/mail/ngx_mail_core_module.xml @ 664:8283b1048b27

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Translated mail modules into English.
author Vladimir Homutov <vl@nginx.com>
date Wed, 05 Sep 2012 14:07:43 +0000
parents
children ddec437b692b
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_core_module"
11 link="/en/docs/mail/ngx_mail_core_module.html"
12 lang="en"
13 rev="1">
14
15 <section id="summary">
16
17 <para>
18 This module is not built by default, it should be
19 enabled with
20 the <literal>--with-mail</literal> configuration parameter.
21 </para>
22
23 </section>
24
25
26 <section id="example" name="Example configuration">
27
28 <para>
29 <example>
30 worker_processes 1;
31
32 error_log /var/log/nginx/error.log info;
33
34 mail {
35 server_name mail.example.com;
36 auth_http localhost:9000/cgi-bin/nginxauth.cgi;
37
38 imap_capabilities IMAP4rev1 UIDPLUS IDLE LITERAL+ QUOTA;
39
40 pop3_auth plain apop cram-md5;
41 pop3_capabilities LAST TOP USER PIPELINING UIDL;
42
43 smtp_auth login plain cram-md5;
44 smtp_capabilities "SIZE 10485760" ENHANCEDSTATUSCODES 8BITMIME DSN;
45 xclient off;
46
47 server {
48 listen 25;
49 protocol smtp;
50 }
51 server {
52 listen 110;
53 protocol pop3;
54 proxy_pass_error_message on;
55 }
56 server {
57 listen 143;
58 protocol imap;
59 }
60 server {
61 listen 587;
62 protocol smtp;
63 }
64 }
65 </example>
66 </para>
67
68 </section>
69
70
71 <section id="directives" name="Directives">
72
73 <directive name="listen">
74 <syntax>
75 <value>address</value>:<value>port</value>
76 [<literal>bind</literal>]</syntax>
77 <default/>
78 <context>server</context>
79
80 <para>
81 Sets an <value>address</value> and a <value>port</value> for for a socket,
82 on which the server will accept requests.
83 Only port may be specified.
84 An address may also be a hostname, for example:
85 <example>
86 listen 127.0.0.1:110;
87 listen *:110;
88 listen 110; # то же, что и *:110
89 listen localhost:110;
90 </example>
91 IPv6 addresses (0.7.58) are specified in square brackets:
92 <example>
93 listen [::1]:110;
94 listen [::]:110;
95 </example>
96 UNIX-domain sockets (1.3.5) are specified with the “<literal>unix:</literal>”
97 prefix:
98 <example>
99 listen unix:/var/run/nginx.sock;
100 </example>
101
102 </para>
103
104 <para>
105 The optional <literal>bind</literal> parameter
106 instructs to make a separate <c-func>bind</c-func>
107 call for a given address:port pair.
108 The fact is that nginx will <c-func>bind</c-func> only to
109 <literal>*:</literal><value>port</value>
110 if there are several <literal>listen</literal> directives with
111 the same port but different addresses, and one of the
112 <literal>listen</literal> directives listens on all addresses
113 for the given port (<literal>*:</literal><value>port</value>).
114 It should be noted that the <c-func>getsockname</c-func> system call will be
115 made in this case to determine an address that accepted a connection.
116 </para>
117
118 <para>
119 Different virtual servers must listen on different
120 <value>address</value>:<value>port</value> pairs.
121 </para>
122
123 </directive>
124
125
126 <directive name="protocol">
127 <syntax>
128 <literal>imap</literal> |
129 <literal>pop3</literal> |
130 <literal>smtp</literal></syntax>
131 <default/>
132 <context>server</context>
133
134 <para>
135 Sets the protocol of a proxied server.
136 Supported protocols are
137 <link doc="ngx_mail_imap_module.xml">IMAP</link>,
138 <link doc="ngx_mail_pop3_module.xml">POP3</link> and
139 <link doc="ngx_mail_smtp_module.xml">SMTP</link>.
140 </para>
141
142 <para>
143 If the directive is not set, the protocol can be detected automatically
144 basing on the well-known port specified in the <link id="listen"/>
145 directive:
146 <list type="bullet">
147
148 <listitem>
149 <literal>imap</literal>: 143, 993
150 </listitem>
151
152 <listitem>
153 <literal>pop3</literal>: 110, 995
154 </listitem>
155
156 <listitem>
157 <literal>smtp</literal>: 25, 587, 465
158 </listitem>
159
160 </list>
161 </para>
162
163 <para>
164 Unnecessary protocols can be disabled using the
165 <link doc="../install.xml">configuration</link>
166 parameters <literal>--without-mail_imap_module</literal>,
167 <literal>--without-mail_pop3_module</literal> and
168 <literal>--without-mail_smtp_module</literal>.
169 </para>
170
171 </directive>
172
173
174 <directive name="server">
175 <syntax block="yes"/>
176 <default/>
177 <context>mail</context>
178
179 <para>
180 Sets a configuration for the virtual server.
181 </para>
182
183 </directive>
184
185
186 <directive name="server_name">
187 <syntax><value>name</value></syntax>
188 <default>hostname</default>
189 <context>mail</context>
190 <context>server</context>
191
192 <para>
193 Sets a name of the virtual server, used:
194
195 <list type="bullet">
196
197 <listitem>
198 in the initial POP3/SMTP server greeting;
199 </listitem>
200
201 <listitem>
202 in the salt during the SASL CRAM-MD5 authentication;
203 </listitem>
204
205 <listitem>
206 in the <literal>EHLO</literal> command on the SMTP backend connection,
207 if the <link doc="ngx_mail_proxy_module.xml" id="xclient"/> command
208 is turned on.
209 </listitem>
210
211 </list>
212
213 </para>
214
215 </directive>
216
217
218 <directive name="so_keepalive">
219 <syntax><literal>on</literal> | <literal>off</literal></syntax>
220 <default>off</default>
221 <context>mail</context>
222 <context>server</context>
223
224 <para>
225 Controls if the “TCP keepalive” mode should be enabled on the client’s
226 connection (<c-def>SO_KEEPALIVE</c-def> socket parameter) on the
227 proxied server connection.
228 </para>
229
230 </directive>
231
232
233 <directive name="timeout">
234 <syntax><value>time</value></syntax>
235 <default>60s</default>
236 <context>mail</context>
237 <context>server</context>
238
239 <para>
240 Sets the timeout which is used before proxying to the backend started.
241 </para>
242
243 </directive>
244
245 </section>
246
247 </module>