nginx-site: xml/en/docs/mail/ngx_mail_core

annotate xml/en/docs/mail/ngx_mail_core_module.xml @ 2471:c8f0f30e1513

Added a note about DNS spoofing to all "resolver" directives.

author	Ruslan Ermilov <ru@nginx.com>
date	Mon, 02 Dec 2019 13:39:23 +0300
parents	1b0cc44de0fd
children	468e6e14e5cc

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"
2471 c8f0f30e1513 Added a note about DNS spoofing to all "resolver" directives. Ruslan Ermilov <ru@nginx.com> parents: 2453 diff changeset	13 rev="14">
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 b0e56cc57867 Fixed section names. Ruslan Ermilov <ru@nginx.com> parents: 1070 diff changeset	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 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	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 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	93 It is possible to specify just the port.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	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 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	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 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	166 for the given port (<literal>*:</literal><value>port</value>), nginx will
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	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 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	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 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	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 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	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 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	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 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	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 a2aea48ff155 New "installation" article. Ruslan Ermilov <ru@nginx.com> parents: 761 diff changeset	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 b81ad8234f90 Minor assorted fixes. Sergey Kandaurov <pluknet@nginx.com> parents: 966 diff changeset	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>
2451 721f78cff4ef Documented resolver statistics for stream and mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 1963 diff changeset	286 <value>address</value> ...
721f78cff4ef Documented resolver statistics for stream and mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 1963 diff changeset	287 [<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	288 [<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	289 [<literal>status_zone</literal>=<value>zone</value>]</syntax>
1068 0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	290 <syntax><literal>off</literal></syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	291 <default>off</default>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	292 <context>mail</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	293 <context>server</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	294
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	295 <para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	296 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	297 to pass it to the
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	298 <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	299 and in the
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	300 <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	301 command when proxying SMTP.
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	302 For example:
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 resolver 127.0.0.1 [::1]:5353;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	305 </example>
2452 4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2451 diff changeset	306 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	307 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	308 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	309 Name servers are queried in a round-robin fashion.
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	310 <note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	311 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	312 Specifying name servers using IPv6 addresses is supported
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	313 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	314 </note>
2452 4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2451 diff changeset	315 </para>
4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2451 diff changeset	316
2453 1b0cc44de0fd Documented the "ipv6=" parameter for resolver in mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 2452 diff changeset	317 <para id="resolver_ipv6">
1b0cc44de0fd Documented the "ipv6=" parameter for resolver in mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 2452 diff changeset	318 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	319 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	320 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	321 <note>
1b0cc44de0fd Documented the "ipv6=" parameter for resolver in mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 2452 diff changeset	322 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	323 starting from version 1.5.8.
1b0cc44de0fd Documented the "ipv6=" parameter for resolver in mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 2452 diff changeset	324 </note>
1b0cc44de0fd Documented the "ipv6=" parameter for resolver in mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 2452 diff changeset	325 </para>
1b0cc44de0fd Documented the "ipv6=" parameter for resolver in mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 2452 diff changeset	326
2452 4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2451 diff changeset	327 <para id="resolver_valid">
1068 0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	328 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	329 An optional <literal>valid</literal> parameter allows overriding it:
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	330 <example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	331 resolver 127.0.0.1 [::1]:5353 valid=30s;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	332 </example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	333 <note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	334 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	335 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	336 </note>
2471 c8f0f30e1513 Added a note about DNS spoofing to all "resolver" directives. Ruslan Ermilov <ru@nginx.com> parents: 2453 diff changeset	337 <note>
c8f0f30e1513 Added a note about DNS spoofing to all "resolver" directives. Ruslan Ermilov <ru@nginx.com> parents: 2453 diff changeset	338 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	339 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	340 </note>
1068 0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	341 </para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	342
2451 721f78cff4ef Documented resolver statistics for stream and mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 1963 diff changeset	343 <para id="resolver_status_zone">
721f78cff4ef Documented resolver statistics for stream and mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 1963 diff changeset	344 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	345 enables
721f78cff4ef Documented resolver statistics for stream and mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 1963 diff changeset	346 <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	347 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	348 in the specified <value>zone</value>.
721f78cff4ef Documented resolver statistics for stream and mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 1963 diff changeset	349 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	350 <commercial_version>commercial subscription</commercial_version>.
721f78cff4ef Documented resolver statistics for stream and mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 1963 diff changeset	351 </para>
721f78cff4ef Documented resolver statistics for stream and mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 1963 diff changeset	352
2452 4487310de7e7 Added IDs to resolver parameters, minor language fixes in resolver. Yaroslav Zhuravlev <yar@nginx.com> parents: 2451 diff changeset	353 <para id="resolver_off">
1068 0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	354 The special value <literal>off</literal> disables resolving.
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	355 </para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	356
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	357 </directive>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	358
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	359
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	360 <directive name="resolver_timeout">
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	361 <syntax><value>time</value></syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	362 <default>30s</default>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	363 <context>mail</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	364 <context>server</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	365
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	366 <para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	367 Sets a timeout for DNS operations, for example:
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	368 <example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	369 resolver_timeout 5s;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	370 </example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	371 </para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	372
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	373 </directive>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	374
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	375
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	376 <directive name="server">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	377 <syntax block="yes"/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	378 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	379 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	380
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	381 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	382 Sets the configuration for a server.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	383 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	384
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	385 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	386
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	387
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	388 <directive name="server_name">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	389 <syntax><value>name</value></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	390 <default>hostname</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	391 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	392 <context>server</context>
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 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	395 Sets the server name that is used:
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	396 <list type="bullet">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	397
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	398 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	399 in the initial POP3/SMTP server greeting;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	400 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	401
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	402 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	403 in the salt during the SASL CRAM-MD5 authentication;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	404 </listitem>
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 <listitem>
1070 73b31b44d3a0 Updated and simplified the "xclient" directive description. Sergey Kandaurov <pluknet@nginx.com> parents: 1069 diff changeset	407 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	408 if the passing of the
73b31b44d3a0 Updated and simplified the "xclient" directive description. Sergey Kandaurov <pluknet@nginx.com> parents: 1069 diff changeset	409 <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	410 is enabled.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	411 </listitem>
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 </list>
1069 71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	414 </para>
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	415
1069 71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	416 <para>
71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	417 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	418 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	419
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	420 </directive>
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
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	423 <directive name="timeout">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	424 <syntax><value>time</value></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	425 <default>60s</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	426 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	427 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	428
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	429 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	430 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	431 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	432
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	433 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	434
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	435 </section>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	436
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	437 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/mail/ngx_mail_core_module.xml @ 2471:c8f0f30e1513