Mercurial > hg > nginx-site
annotate xml/en/docs/mail/ngx_mail_core_module.xml @ 2847:f5e49925e9db
Documented the njs.version_number property in njs.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 17 May 2022 12:49:45 +0100 |
parents | 00afc7c4d4df |
children | e06cf66a9f63 |
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" |
2724
00afc7c4d4df
Documented listen options that imply "bind".
Ruslan Ermilov <ru@nginx.com>
parents:
2722
diff
changeset
|
13 rev="19"> |
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> |
2690
4d073d1b0b79
Updated worker_processes value in Example configuration for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2676
diff
changeset
|
30 worker_processes auto; |
664
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>] |
2676
468e6e14e5cc
Documented the PROXY protocol support in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2471
diff
changeset
|
81 [<literal>proxy_protocol</literal>] |
1502
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
82 [<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
|
83 [<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
|
84 [<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
|
85 [<literal>bind</literal>] |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
86 [<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
|
87 [<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
|
88 <default/> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
89 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
90 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
91 <para> |
966 | 92 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
|
93 on which the server will accept requests. |
966 | 94 It is possible to specify just the port. |
95 The address can also be a hostname, for example: | |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
96 <example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
97 listen 127.0.0.1:110; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
98 listen *:110; |
761
84740807c806
Translated commentary in Russian in the English part of documentation.
Vladimir Homutov <vl@nginx.com>
parents:
751
diff
changeset
|
99 listen 110; # same as *:110 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
100 listen localhost:110; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
101 </example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
102 IPv6 addresses (0.7.58) are specified in square brackets: |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
103 <example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
104 listen [::1]:110; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
105 listen [::]:110; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
106 </example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
107 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
|
108 prefix: |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
109 <example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
110 listen unix:/var/run/nginx.sock; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
111 </example> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
112 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
113 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
114 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
115 <para> |
1489
9f9b8543b946
Relocated phrase in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1488
diff
changeset
|
116 Different servers must listen on different |
9f9b8543b946
Relocated phrase in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1488
diff
changeset
|
117 <value>address</value>:<value>port</value> pairs. |
9f9b8543b946
Relocated phrase in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1488
diff
changeset
|
118 </para> |
9f9b8543b946
Relocated phrase in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1488
diff
changeset
|
119 |
9f9b8543b946
Relocated phrase in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1488
diff
changeset
|
120 <para> |
1488
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
121 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
|
122 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
|
123 </para> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
124 |
2676
468e6e14e5cc
Documented the PROXY protocol support in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2471
diff
changeset
|
125 <para id="proxy_protocol"> |
468e6e14e5cc
Documented the PROXY protocol support in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2471
diff
changeset
|
126 The <literal>proxy_protocol</literal> parameter (1.19.8) |
468e6e14e5cc
Documented the PROXY protocol support in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2471
diff
changeset
|
127 allows specifying that all connections accepted on this port should use the |
468e6e14e5cc
Documented the PROXY protocol support in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2471
diff
changeset
|
128 <link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">PROXY |
468e6e14e5cc
Documented the PROXY protocol support in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2471
diff
changeset
|
129 protocol</link>. |
468e6e14e5cc
Documented the PROXY protocol support in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2471
diff
changeset
|
130 Obtained information is passed to the |
2691
5f961aa083db
Mentioned realip module in the listen directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2690
diff
changeset
|
131 <link doc="ngx_mail_auth_http_module.xml" id="proxy_protocol">authentication server</link> |
5f961aa083db
Mentioned realip module in the listen directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2690
diff
changeset
|
132 and can be used to |
5f961aa083db
Mentioned realip module in the listen directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2690
diff
changeset
|
133 <link doc="ngx_mail_realip_module.xml">change the client address</link>. |
2676
468e6e14e5cc
Documented the PROXY protocol support in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2471
diff
changeset
|
134 </para> |
468e6e14e5cc
Documented the PROXY protocol support in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2471
diff
changeset
|
135 |
1488
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
136 <para> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
137 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
|
138 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
|
139 <list type="tag"> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
140 |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
141 <tag-name> |
1502
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
142 <literal>backlog</literal>=<value>number</value> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
143 </tag-name> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
144 <tag-desc> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
145 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
|
146 <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
|
147 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
|
148 By default, |
1911
f024ac0ec5c7
Apple rebranded Mac OS X to macOS.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1528
diff
changeset
|
149 <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
|
150 and to 511 on other platforms. |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
151 </tag-desc> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
152 |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1489
diff
changeset
|
153 <tag-name> |
1963
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
154 <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
|
155 </tag-name> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
156 <tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
157 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
|
158 (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
|
159 </tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
160 |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
161 <tag-name> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
162 <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
|
163 </tag-name> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
164 <tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
165 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
|
166 (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
|
167 </tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
168 |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
169 <tag-name> |
1488
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
170 <literal>bind</literal> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
171 </tag-name> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
172 <tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
173 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
|
174 call for a given address:port pair. |
966 | 175 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
|
176 the same port but different addresses, and one of the |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
177 <literal>listen</literal> directives listens on all addresses |
966 | 178 for the given port (<literal>*:</literal><value>port</value>), nginx will |
179 <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
|
180 It should be noted that the <c-func>getsockname</c-func> system call will be |
966 | 181 made in this case to determine the address that accepted the connection. |
2724
00afc7c4d4df
Documented listen options that imply "bind".
Ruslan Ermilov <ru@nginx.com>
parents:
2722
diff
changeset
|
182 If the <literal>backlog</literal>, |
00afc7c4d4df
Documented listen options that imply "bind".
Ruslan Ermilov <ru@nginx.com>
parents:
2722
diff
changeset
|
183 <literal>rcvbuf</literal>, <literal>sndbuf</literal>, |
00afc7c4d4df
Documented listen options that imply "bind".
Ruslan Ermilov <ru@nginx.com>
parents:
2722
diff
changeset
|
184 <literal>ipv6only</literal>, |
1488
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
185 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
|
186 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
|
187 <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
|
188 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
|
189 </tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
190 |
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 <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
|
193 </tag-name> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
194 <tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
195 this parameter determines |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
196 (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
|
197 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
|
198 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
|
199 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
|
200 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
|
201 </tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
202 |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
203 <tag-name> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
204 <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
|
205 </tag-name> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
206 <tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
207 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
|
208 for the listening socket. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
209 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
|
210 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
|
211 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
|
212 <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
|
213 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
|
214 <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
|
215 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
|
216 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
|
217 <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
|
218 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
|
219 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
|
220 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
|
221 <value>keepcnt</value> parameters. |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
222 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
|
223 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
|
224 For example, |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
225 <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
|
226 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
|
227 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
|
228 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
|
229 </tag-desc> |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
230 |
0a1c5a087556
Documented bind/ipv6only/ssl/so_keepalive in mail listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1471
diff
changeset
|
231 </list> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
232 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
233 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
234 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
235 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
236 |
748
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
237 <directive name="mail"> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
238 <syntax block="yes"/> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
239 <default/> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
240 <context>main</context> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
241 |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
242 <para> |
966 | 243 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
|
244 are specified. |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
245 </para> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
246 |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
247 </directive> |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
248 |
95344046d2d8
Documented 'mail' directive.
Vladimir Homutov <vl@nginx.com>
parents:
747
diff
changeset
|
249 |
2722
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
250 <directive name="max_errors"> |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
251 <syntax><value>number</value></syntax> |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
252 <default>5</default> |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
253 <context>mail</context> |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
254 <context>server</context> |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
255 <appeared-in>1.21.0</appeared-in> |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
256 |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
257 <para> |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
258 Sets the number of protocol errors after which the connection is closed. |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
259 </para> |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
260 |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
261 </directive> |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
262 |
1261698ec228
Documented the max_errors directive for mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2691
diff
changeset
|
263 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
264 <directive name="protocol"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
265 <syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
266 <literal>imap</literal> | |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
267 <literal>pop3</literal> | |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
268 <literal>smtp</literal></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
269 <default/> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
270 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
271 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
272 <para> |
966 | 273 Sets the protocol for a proxied server. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
274 Supported protocols are |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
275 <link doc="ngx_mail_imap_module.xml">IMAP</link>, |
966 | 276 <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
|
277 <link doc="ngx_mail_smtp_module.xml">SMTP</link>. |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
278 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
279 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
280 <para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
281 If the directive is not set, the protocol can be detected automatically |
966 | 282 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
|
283 directive: |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
284 <list type="bullet"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
285 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
286 <listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
287 <literal>imap</literal>: 143, 993 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
288 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
289 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
290 <listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
291 <literal>pop3</literal>: 110, 995 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
292 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
293 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
294 <listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
295 <literal>smtp</literal>: 25, 587, 465 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
296 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
297 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
298 </list> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
299 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
300 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
301 <para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
302 Unnecessary protocols can be disabled using the |
924 | 303 <link doc="../configure.xml">configuration</link> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
304 parameters <literal>--without-mail_imap_module</literal>, |
1046 | 305 <literal>--without-mail_pop3_module</literal>, and |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
306 <literal>--without-mail_smtp_module</literal>. |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
307 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
308 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
309 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
310 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
311 |
1068
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
312 <directive name="resolver"> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
313 <syntax> |
2451
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
314 <value>address</value> ... |
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
315 [<literal>valid</literal>=<value>time</value>] |
2453
1b0cc44de0fd
Documented the "ipv6=" parameter for resolver in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
316 [<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>] |
2451
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
317 [<literal>status_zone</literal>=<value>zone</value>]</syntax> |
1068
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
318 <syntax><literal>off</literal></syntax> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
319 <default>off</default> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
320 <context>mail</context> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
321 <context>server</context> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
322 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
323 <para> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
324 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
|
325 to pass it to the |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
326 <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
|
327 and in the |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
328 <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
|
329 command when proxying SMTP. |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
330 For example: |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
331 <example> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
332 resolver 127.0.0.1 [::1]:5353; |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
333 </example> |
2452
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2451
diff
changeset
|
334 The address can be specified as a domain name or IP address, |
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2451
diff
changeset
|
335 with an optional port (1.3.1, 1.2.2). |
1068
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
336 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
|
337 Name servers are queried in a round-robin fashion. |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
338 <note> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
339 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
|
340 Specifying name servers using IPv6 addresses is supported |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
341 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
|
342 </note> |
2452
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2451
diff
changeset
|
343 </para> |
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2451
diff
changeset
|
344 |
2453
1b0cc44de0fd
Documented the "ipv6=" parameter for resolver in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
345 <para id="resolver_ipv6"> |
1b0cc44de0fd
Documented the "ipv6=" parameter for resolver in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
346 By default, nginx will look up both IPv4 and IPv6 addresses while resolving. |
1b0cc44de0fd
Documented the "ipv6=" parameter for resolver in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
347 If looking up of IPv6 addresses is not desired, |
1b0cc44de0fd
Documented the "ipv6=" parameter for resolver in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
348 the <literal>ipv6=off</literal> parameter can be specified. |
1b0cc44de0fd
Documented the "ipv6=" parameter for resolver in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
349 <note> |
1b0cc44de0fd
Documented the "ipv6=" parameter for resolver in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
350 Resolving of names into IPv6 addresses is supported |
1b0cc44de0fd
Documented the "ipv6=" parameter for resolver in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
351 starting from version 1.5.8. |
1b0cc44de0fd
Documented the "ipv6=" parameter for resolver in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
352 </note> |
1b0cc44de0fd
Documented the "ipv6=" parameter for resolver in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
353 </para> |
1b0cc44de0fd
Documented the "ipv6=" parameter for resolver in mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
354 |
2452
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2451
diff
changeset
|
355 <para id="resolver_valid"> |
1068
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
356 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
|
357 An optional <literal>valid</literal> parameter allows overriding it: |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
358 <example> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
359 resolver 127.0.0.1 [::1]:5353 valid=30s; |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
360 </example> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
361 <note> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
362 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
|
363 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
|
364 </note> |
2471
c8f0f30e1513
Added a note about DNS spoofing to all "resolver" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
2453
diff
changeset
|
365 <note> |
c8f0f30e1513
Added a note about DNS spoofing to all "resolver" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
2453
diff
changeset
|
366 To prevent DNS spoofing, it is recommended |
c8f0f30e1513
Added a note about DNS spoofing to all "resolver" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
2453
diff
changeset
|
367 configuring DNS servers in a properly secured trusted local network. |
c8f0f30e1513
Added a note about DNS spoofing to all "resolver" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
2453
diff
changeset
|
368 </note> |
1068
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
369 </para> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
370 |
2451
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
371 <para id="resolver_status_zone"> |
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
372 The optional <literal>status_zone</literal> parameter (1.17.1) |
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
373 enables |
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
374 <link doc="../http/ngx_http_api_module.xml" id="resolvers_">collection</link> |
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
375 of DNS server statistics of requests and responses |
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
376 in the specified <value>zone</value>. |
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
377 The parameter is available as part of our |
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
378 <commercial_version>commercial subscription</commercial_version>. |
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
379 </para> |
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
380 |
2452
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2451
diff
changeset
|
381 <para id="resolver_off"> |
1068
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
382 The special value <literal>off</literal> disables resolving. |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
383 </para> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
384 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
385 </directive> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
386 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
387 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
388 <directive name="resolver_timeout"> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
389 <syntax><value>time</value></syntax> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
390 <default>30s</default> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
391 <context>mail</context> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
392 <context>server</context> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
393 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
394 <para> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
395 Sets a timeout for DNS operations, for example: |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
396 <example> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
397 resolver_timeout 5s; |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
398 </example> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
399 </para> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
400 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
401 </directive> |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
402 |
0c5f8630fe40
Documented the mail "resolver" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1046
diff
changeset
|
403 |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
404 <directive name="server"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
405 <syntax block="yes"/> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
406 <default/> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
407 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
408 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
409 <para> |
966 | 410 Sets the configuration for a server. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
411 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
412 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
413 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
414 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
415 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
416 <directive name="server_name"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
417 <syntax><value>name</value></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
418 <default>hostname</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
419 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
420 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
421 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
422 <para> |
966 | 423 Sets the server name that is used: |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
424 <list type="bullet"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
425 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
426 <listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
427 in the initial POP3/SMTP server greeting; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
428 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
429 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
430 <listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
431 in the salt during the SASL CRAM-MD5 authentication; |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
432 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
433 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
434 <listitem> |
1070
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1069
diff
changeset
|
435 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
|
436 if the passing of the |
73b31b44d3a0
Updated and simplified the "xclient" directive description.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1069
diff
changeset
|
437 <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
|
438 is enabled. |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
439 </listitem> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
440 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
441 </list> |
1069
71e6daffa4dc
Documented behavior in the absence of the "server_name" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1068
diff
changeset
|
442 </para> |
664
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
443 |
1069
71e6daffa4dc
Documented behavior in the absence of the "server_name" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1068
diff
changeset
|
444 <para> |
71e6daffa4dc
Documented behavior in the absence of the "server_name" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1068
diff
changeset
|
445 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
|
446 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
447 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
448 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
449 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
450 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
451 <directive name="timeout"> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
452 <syntax><value>time</value></syntax> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
453 <default>60s</default> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
454 <context>mail</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
455 <context>server</context> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
456 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
457 <para> |
966 | 458 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
|
459 </para> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
460 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
461 </directive> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
462 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
463 </section> |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
464 |
8283b1048b27
Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
465 </module> |