Mercurial > hg > nginx-site
annotate xml/en/docs/mail/ngx_mail_core_module.xml @ 2016:e6de97d14f81
Documented the mirror module.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Fri, 04 Aug 2017 18:24:38 +0300 |
parents | 351cefd5ff9c |
children | 721f78cff4ef |
rev | line source |
---|---|
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3 <!-- |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4 Copyright (C) 2006, 2007 Anton Yuzhaninov |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
5 Copyright (C) Nginx, Inc. |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
6 --> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
7 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
9 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
10 <module name="Module ngx_mail_core_module" |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/mail/ngx_mail_core_module.html" |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
12 lang="en" |
1963
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
13 rev="10"> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
14 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
15 <section id="summary"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
16 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
17 <para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
18 This module is not built by default, it should be |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
19 enabled with |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
20 the <literal>--with-mail</literal> configuration parameter. |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
21 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
22 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
23 </section> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
24 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
25 |
1154 | 26 <section id="example" name="Example Configuration"> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
27 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
28 <para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
29 <example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
30 worker_processes 1; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
31 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
32 error_log /var/log/nginx/error.log info; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
33 |
1528
3ae5301ea37a
Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1502
diff
changeset
|
34 events { |
3ae5301ea37a
Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1502
diff
changeset
|
35 worker_connections 1024; |
3ae5301ea37a
Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1502
diff
changeset
|
36 } |
3ae5301ea37a
Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1502
diff
changeset
|
37 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
38 mail { |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
39 server_name mail.example.com; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
40 auth_http localhost:9000/cgi-bin/nginxauth.cgi; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
41 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
42 imap_capabilities IMAP4rev1 UIDPLUS IDLE LITERAL+ QUOTA; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
43 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
44 pop3_auth plain apop cram-md5; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
45 pop3_capabilities LAST TOP USER PIPELINING UIDL; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
46 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
47 smtp_auth login plain cram-md5; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
48 smtp_capabilities "SIZE 10485760" ENHANCEDSTATUSCODES 8BITMIME DSN; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
49 xclient off; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
50 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
51 server { |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
52 listen 25; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
53 protocol smtp; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
54 } |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
55 server { |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
56 listen 110; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
57 protocol pop3; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
58 proxy_pass_error_message on; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
59 } |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
60 server { |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
61 listen 143; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
62 protocol imap; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
63 } |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
64 server { |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
65 listen 587; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
66 protocol smtp; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
67 } |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
68 } |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
69 </example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
70 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
71 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
72 </section> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
73 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
74 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
75 <section id="directives" name="Directives"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
76 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
77 <directive name="listen"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
78 <syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
79 <value>address</value>:<value>port</value> |
1488
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
80 [<literal>ssl</literal>] |
1502
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
81 [<literal>backlog</literal>=<value>number</value>] |
1963
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
82 [<literal>rcvbuf</literal>=<value>size</value>] |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
83 [<literal>sndbuf</literal>=<value>size</value>] |
1488
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
84 [<literal>bind</literal>] |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
85 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
86 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
87 <default/> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
88 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
89 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
90 <para> |
966 | 91 Sets the <value>address</value> and <value>port</value> for the socket |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
92 on which the server will accept requests. |
966 | 93 It is possible to specify just the port. |
94 The address can also be a hostname, for example: | |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
95 <example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
96 listen 127.0.0.1:110; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
97 listen *:110; |
761
84740807c806
Translated commentary in Russian in the English part of documentation.
Vladimir Homutov <vl@nginx.com>
parents:
751
diff
changeset
|
98 listen 110; # same as *:110 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
99 listen localhost:110; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
100 </example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
101 IPv6 addresses (0.7.58) are specified in square brackets: |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
102 <example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
103 listen [::1]:110; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
104 listen [::]:110; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
105 </example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
106 UNIX-domain sockets (1.3.5) are specified with the “<literal>unix:</literal>” |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
107 prefix: |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
108 <example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
109 listen unix:/var/run/nginx.sock; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
110 </example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
111 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
112 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
113 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
114 <para> |
1489
9f9b8543b946
Relocated phrase in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1488
diff
changeset
|
115 Different servers must listen on different |
9f9b8543b946
Relocated phrase in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1488
diff
changeset
|
116 <value>address</value>:<value>port</value> pairs. |
9f9b8543b946
Relocated phrase in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1488
diff
changeset
|
117 </para> |
9f9b8543b946
Relocated phrase in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1488
diff
changeset
|
118 |
9f9b8543b946
Relocated phrase in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1488
diff
changeset
|
119 <para> |
1488
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
120 The <literal>ssl</literal> parameter allows specifying that all |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
121 connections accepted on this port should work in SSL mode. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
122 </para> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
123 |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
124 <para> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
125 The <literal>listen</literal> directive |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
126 can have several additional parameters specific to socket-related system calls. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
127 <list type="tag"> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
128 |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
129 <tag-name> |
1502
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
130 <literal>backlog</literal>=<value>number</value> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
131 </tag-name> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
132 <tag-desc> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
133 sets the <literal>backlog</literal> parameter in the |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
134 <c-func>listen</c-func> call that limits |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
135 the maximum length for the queue of pending connections (1.9.2). |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
136 By default, |
1911
f024ac0ec5c7
Apple rebranded Mac OS X to macOS.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1528
diff
changeset
|
137 <literal>backlog</literal> is set to -1 on FreeBSD, DragonFly BSD, and macOS, |
1502
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
138 and to 511 on other platforms. |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
139 </tag-desc> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
140 |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
141 <tag-name> |
1963
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
142 <literal>rcvbuf</literal>=<value>size</value> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
143 </tag-name> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
144 <tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
145 sets the receive buffer size |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
146 (the <c-def>SO_RCVBUF</c-def> option) for the listening socket (1.11.13). |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
147 </tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
148 |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
149 <tag-name> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
150 <literal>sndbuf</literal>=<value>size</value> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
151 </tag-name> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
152 <tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
153 sets the send buffer size |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
154 (the <c-def>SO_SNDBUF</c-def> option) for the listening socket (1.11.13). |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
155 </tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
156 |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
157 <tag-name> |
1488
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
158 <literal>bind</literal> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
159 </tag-name> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
160 <tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
161 this parameter instructs to make a separate <c-func>bind</c-func> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
162 call for a given address:port pair. |
966 | 163 The fact is that if there are several <literal>listen</literal> directives with |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
164 the same port but different addresses, and one of the |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
165 <literal>listen</literal> directives listens on all addresses |
966 | 166 for the given port (<literal>*:</literal><value>port</value>), nginx will |
167 <c-func>bind</c-func> only to <literal>*:</literal><value>port</value>. | |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
168 It should be noted that the <c-func>getsockname</c-func> system call will be |
966 | 169 made in this case to determine the address that accepted the connection. |
1488
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
170 If the <literal>ipv6only</literal> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
171 or <literal>so_keepalive</literal> parameters |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
172 are used then for a given |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
173 <value>address</value>:<value>port</value> pair |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
174 a separate <c-func>bind</c-func> call will always be made. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
175 </tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
176 |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
177 <tag-name> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
178 <literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
179 </tag-name> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
180 <tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
181 this parameter determines |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
182 (via the <c-def>IPV6_V6ONLY</c-def> socket option) |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
183 whether an IPv6 socket listening on a wildcard address <literal>[::]</literal> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
184 will accept only IPv6 connections or both IPv6 and IPv4 connections. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
185 This parameter is turned on by default. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
186 It can only be set once on start. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
187 </tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
188 |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
189 <tag-name> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
190 <literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>] |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
191 </tag-name> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
192 <tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
193 this parameter configures the “TCP keepalive” behavior |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
194 for the listening socket. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
195 If this parameter is omitted then the operating system’s settings will be |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
196 in effect for the socket. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
197 If it is set to the value “<literal>on</literal>”, the |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
198 <c-def>SO_KEEPALIVE</c-def> option is turned on for the socket. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
199 If it is set to the value “<literal>off</literal>”, the |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
200 <c-def>SO_KEEPALIVE</c-def> option is turned off for the socket. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
201 Some operating systems support setting of TCP keepalive parameters on |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
202 a per-socket basis using the <c-def>TCP_KEEPIDLE</c-def>, |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
203 <c-def>TCP_KEEPINTVL</c-def>, and <c-def>TCP_KEEPCNT</c-def> socket options. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
204 On such systems (currently, Linux 2.4+, NetBSD 5+, and |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
205 FreeBSD 9.0-STABLE), they can be configured |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
206 using the <value>keepidle</value>, <value>keepintvl</value>, and |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
207 <value>keepcnt</value> parameters. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
208 One or two parameters may be omitted, in which case the system default setting |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
209 for the corresponding socket option will be in effect. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
210 For example, |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
211 <example>so_keepalive=30m::10</example> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
212 will set the idle timeout (<c-def>TCP_KEEPIDLE</c-def>) to 30 minutes, |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
213 leave the probe interval (<c-def>TCP_KEEPINTVL</c-def>) at its system default, |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
214 and set the probes count (<c-def>TCP_KEEPCNT</c-def>) to 10 probes. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
215 </tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
216 |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
217 </list> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
218 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
219 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
220 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
221 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
222 |
748
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
223 <directive name="mail"> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
224 <syntax block="yes"/> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
225 <default/> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
226 <context>main</context> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
227 |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
228 <para> |
966 | 229 Provides the configuration file context in which the mail server directives |
748
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
230 are specified. |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
231 </para> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
232 |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
233 </directive> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
234 |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
235 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
236 <directive name="protocol"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
237 <syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
238 <literal>imap</literal> | |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
239 <literal>pop3</literal> | |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
240 <literal>smtp</literal></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
241 <default/> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
242 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
243 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
244 <para> |
966 | 245 Sets the protocol for a proxied server. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
246 Supported protocols are |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
247 <link doc="ngx_mail_imap_module.xml">IMAP</link>, |
966 | 248 <link doc="ngx_mail_pop3_module.xml">POP3</link>, and |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
249 <link doc="ngx_mail_smtp_module.xml">SMTP</link>. |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
250 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
251 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
252 <para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
253 If the directive is not set, the protocol can be detected automatically |
966 | 254 based on the well-known port specified in the <link id="listen"/> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
255 directive: |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
256 <list type="bullet"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
257 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
258 <listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
259 <literal>imap</literal>: 143, 993 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
260 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
261 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
262 <listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
263 <literal>pop3</literal>: 110, 995 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
264 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
265 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
266 <listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
267 <literal>smtp</literal>: 25, 587, 465 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
268 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
269 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
270 </list> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
271 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
272 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
273 <para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
274 Unnecessary protocols can be disabled using the |
924 | 275 <link doc="../configure.xml">configuration</link> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
276 parameters <literal>--without-mail_imap_module</literal>, |
1046 | 277 <literal>--without-mail_pop3_module</literal>, and |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
278 <literal>--without-mail_smtp_module</literal>. |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
279 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
280 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
281 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
282 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
283 |
1068
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
284 <directive name="resolver"> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
285 <syntax> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
286 <value>address</value> ... |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
287 [<literal>valid</literal>=<value>time</value>]</syntax> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
288 <syntax><literal>off</literal></syntax> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
289 <default>off</default> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
290 <context>mail</context> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
291 <context>server</context> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
292 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
293 <para> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
294 Configures name servers used to find the client’s hostname |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
295 to pass it to the |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
296 <link doc="ngx_mail_auth_http_module.xml">authentication server</link>, |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
297 and in the |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
298 <link doc="ngx_mail_proxy_module.xml" id="xclient">XCLIENT</link> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
299 command when proxying SMTP. |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
300 For example: |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
301 <example> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
302 resolver 127.0.0.1 [::1]:5353; |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
303 </example> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
304 An address can be specified as a domain name or IP address, |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
305 and an optional port (1.3.1, 1.2.2). |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
306 If port is not specified, the port 53 is used. |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
307 Name servers are queried in a round-robin fashion. |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
308 <note> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
309 Before version 1.1.7, only a single name server could be configured. |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
310 Specifying name servers using IPv6 addresses is supported |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
311 starting from versions 1.3.1 and 1.2.2. |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
312 </note> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
313 By default, nginx caches answers using the TTL value of a response. |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
314 An optional <literal>valid</literal> parameter allows overriding it: |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
315 <example> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
316 resolver 127.0.0.1 [::1]:5353 valid=30s; |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
317 </example> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
318 <note> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
319 Before version 1.1.9, tuning of caching time was not possible, |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
320 and nginx always cached answers for the duration of 5 minutes. |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
321 </note> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
322 </para> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
323 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
324 <para> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
325 The special value <literal>off</literal> disables resolving. |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
326 </para> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
327 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
328 </directive> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
329 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
330 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
331 <directive name="resolver_timeout"> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
332 <syntax><value>time</value></syntax> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
333 <default>30s</default> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
334 <context>mail</context> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
335 <context>server</context> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
336 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
337 <para> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
338 Sets a timeout for DNS operations, for example: |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
339 <example> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
340 resolver_timeout 5s; |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
341 </example> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
342 </para> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
343 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
344 </directive> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
345 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
346 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
347 <directive name="server"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
348 <syntax block="yes"/> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
349 <default/> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
350 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
351 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
352 <para> |
966 | 353 Sets the configuration for a server. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
354 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
355 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
356 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
357 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
358 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
359 <directive name="server_name"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
360 <syntax><value>name</value></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
361 <default>hostname</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
362 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
363 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
364 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
365 <para> |
966 | 366 Sets the server name that is used: |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
367 <list type="bullet"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
368 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
369 <listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
370 in the initial POP3/SMTP server greeting; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
371 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
372 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
373 <listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
374 in the salt during the SASL CRAM-MD5 authentication; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
375 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
376 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
377 <listitem> |
1070
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1069
diff
changeset
|
378 in the <literal>EHLO</literal> command when connecting to the SMTP backend, |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1069
diff
changeset
|
379 if the passing of the |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1069
diff
changeset
|
380 <link doc="ngx_mail_proxy_module.xml" id="xclient">XCLIENT</link> command |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1069
diff
changeset
|
381 is enabled. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
382 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
383 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
384 </list> |
1069
71e6daffa4dc
Documented behavior in the absence of the "server_name" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1068
diff
changeset
|
385 </para> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
386 |
1069
71e6daffa4dc
Documented behavior in the absence of the "server_name" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1068
diff
changeset
|
387 <para> |
71e6daffa4dc
Documented behavior in the absence of the "server_name" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1068
diff
changeset
|
388 If the directive is not specified, the machine’s hostname is used. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
389 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
390 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
391 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
392 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
393 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
394 <directive name="timeout"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
395 <syntax><value>time</value></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
396 <default>60s</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
397 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
398 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
399 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
400 <para> |
966 | 401 Sets the timeout that is used before proxying to the backend starts. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
402 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
403 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
404 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
405 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
406 </section> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
407 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
408 </module> |