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

annotate xml/en/docs/mail/ngx_mail_core_module.xml @ 1502:b628e042a15e

Documented "listen backlog=" in mail and stream.

author	Ruslan Ermilov <ru@nginx.com>
date	Tue, 09 Jun 2015 14:40:14 +0300
parents	9f9b8543b946
children	3ae5301ea37a

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"
1502 b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	13 rev="7">
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
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	34 mail {
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	35 server_name mail.example.com;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	36 auth_http localhost:9000/cgi-bin/nginxauth.cgi;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	37
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	38 imap_capabilities IMAP4rev1 UIDPLUS IDLE LITERAL+ QUOTA;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	39
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	40 pop3_auth plain apop cram-md5;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	41 pop3_capabilities LAST TOP USER PIPELINING UIDL;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	42
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	43 smtp_auth login plain cram-md5;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	44 smtp_capabilities "SIZE 10485760" ENHANCEDSTATUSCODES 8BITMIME DSN;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	45 xclient off;
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 server {
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	48 listen 25;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	49 protocol smtp;
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 110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	53 protocol pop3;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	54 proxy_pass_error_message on;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	55 }
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	56 server {
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	57 listen 143;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	58 protocol imap;
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 587;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	62 protocol smtp;
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 }
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	65 </example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	66 </para>
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 </section>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	69
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	70
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	71 <section id="directives" name="Directives">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	72
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	73 <directive name="listen">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	74 <syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	75 <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	76 [<literal>ssl</literal>]
1502 b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	77 [<literal>backlog</literal>=<value>number</value>]
1488 0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	78 [<literal>bind</literal>]
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	79 [<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	80 [<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	81 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	82 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	83
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	84 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	85 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	86 on which the server will accept requests.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	87 It is possible to specify just the port.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	88 The address can also be a hostname, for example:
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	89 <example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	90 listen 127.0.0.1:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	91 listen *:110;
761 84740807c806 Translated commentary in Russian in the English part of documentation. Vladimir Homutov <vl@nginx.com> parents: 751 diff changeset	92 listen 110; # same as *:110
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	93 listen localhost:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	94 </example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	95 IPv6 addresses (0.7.58) are specified in square brackets:
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 [::1]:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	98 listen [::]:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	99 </example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	100 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	101 prefix:
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 unix:/var/run/nginx.sock;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	104 </example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	105
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	106 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	107
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	108 <para>
1489 9f9b8543b946 Relocated phrase in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1488 diff changeset	109 Different servers must listen on different
9f9b8543b946 Relocated phrase in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1488 diff changeset	110 <value>address</value>:<value>port</value> pairs.
9f9b8543b946 Relocated phrase in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1488 diff changeset	111 </para>
9f9b8543b946 Relocated phrase in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1488 diff changeset	112
9f9b8543b946 Relocated phrase in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1488 diff changeset	113 <para>
1488 0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	114 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	115 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	116 </para>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	117
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	118 <para>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	119 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	120 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	121 <list type="tag">
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	122
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	123 <tag-name>
1502 b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	124 <literal>backlog</literal>=<value>number</value>
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	125 </tag-name>
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	126 <tag-desc>
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	127 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	128 <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	129 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	130 By default,
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	131 <literal>backlog</literal> is set to -1 on FreeBSD, DragonFly BSD, and Mac OS X,
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	132 and to 511 on other platforms.
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	133 </tag-desc>
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	134
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	135 <tag-name>
1488 0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	136 <literal>bind</literal>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	137 </tag-name>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	138 <tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	139 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	140 call for a given address:port pair.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	141 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	142 the same port but different addresses, and one of the
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	143 <literal>listen</literal> directives listens on all addresses
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	144 for the given port (<literal>*:</literal><value>port</value>), nginx will
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	145 <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	146 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	147 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	148 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	149 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	150 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	151 <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	152 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	153 </tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	154
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	155 <tag-name>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	156 <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	157 </tag-name>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	158 <tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	159 this parameter determines
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	160 (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	161 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	162 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	163 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	164 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	165 </tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	166
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	167 <tag-name>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	168 <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	169 </tag-name>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	170 <tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	171 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	172 for the listening socket.
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	173 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	174 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	175 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	176 <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	177 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	178 <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	179 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	180 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	181 <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	182 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	183 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	184 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	185 <value>keepcnt</value> parameters.
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	186 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	187 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	188 For example,
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	189 <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	190 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	191 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	192 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	193 </tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	194
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	195 </list>
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	196 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	197
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	198 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	199
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	200
748 95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	201 <directive name="mail">
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	202 <syntax block="yes"/>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	203 <default/>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	204 <context>main</context>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	205
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	206 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	207 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	208 are specified.
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	209 </para>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	210
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	211 </directive>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	212
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	213
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	214 <directive name="protocol">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	215 <syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	216 <literal>imap</literal> \|
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	217 <literal>pop3</literal> \|
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	218 <literal>smtp</literal></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	219 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	220 <context>server</context>
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 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	223 Sets the protocol for a proxied server.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	224 Supported protocols are
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	225 <link doc="ngx_mail_imap_module.xml">IMAP</link>,
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	226 <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	227 <link doc="ngx_mail_smtp_module.xml">SMTP</link>.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	228 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	229
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	230 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	231 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	232 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	233 directive:
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	234 <list type="bullet">
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 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	237 <literal>imap</literal>: 143, 993
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	238 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	239
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	240 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	241 <literal>pop3</literal>: 110, 995
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	242 </listitem>
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 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	245 <literal>smtp</literal>: 25, 587, 465
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	246 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	247
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	248 </list>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	249 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	250
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	251 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	252 Unnecessary protocols can be disabled using the
924 a2aea48ff155 New "installation" article. Ruslan Ermilov <ru@nginx.com> parents: 761 diff changeset	253 <link doc="../configure.xml">configuration</link>
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	254 parameters <literal>--without-mail_imap_module</literal>,
1046 b81ad8234f90 Minor assorted fixes. Sergey Kandaurov <pluknet@nginx.com> parents: 966 diff changeset	255 <literal>--without-mail_pop3_module</literal>, and
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	256 <literal>--without-mail_smtp_module</literal>.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	257 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	258
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	259 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	260
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	261
1068 0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	262 <directive name="resolver">
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	263 <syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	264 <value>address</value> ...
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	265 [<literal>valid</literal>=<value>time</value>]</syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	266 <syntax><literal>off</literal></syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	267 <default>off</default>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	268 <context>mail</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	269 <context>server</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	270
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	271 <para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	272 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	273 to pass it to the
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	274 <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	275 and in the
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	276 <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	277 command when proxying SMTP.
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	278 For example:
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	279 <example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	280 resolver 127.0.0.1 [::1]:5353;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	281 </example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	282 An address can be specified as a domain name or IP address,
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	283 and an optional port (1.3.1, 1.2.2).
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	284 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	285 Name servers are queried in a round-robin fashion.
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	286 <note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	287 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	288 Specifying name servers using IPv6 addresses is supported
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	289 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	290 </note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	291 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	292 An optional <literal>valid</literal> parameter allows overriding it:
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	293 <example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	294 resolver 127.0.0.1 [::1]:5353 valid=30s;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	295 </example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	296 <note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	297 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	298 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	299 </note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	300 </para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	301
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	302 <para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	303 The special value <literal>off</literal> disables resolving.
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	304 </para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	305
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	306 </directive>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	307
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	308
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	309 <directive name="resolver_timeout">
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	310 <syntax><value>time</value></syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	311 <default>30s</default>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	312 <context>mail</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	313 <context>server</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	314
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	315 <para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	316 Sets a timeout for DNS operations, for example:
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	317 <example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	318 resolver_timeout 5s;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	319 </example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	320 </para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	321
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	322 </directive>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	323
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	324
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	325 <directive name="server">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	326 <syntax block="yes"/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	327 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	328 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	329
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	330 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	331 Sets the configuration for a server.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	332 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	333
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	334 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	335
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	336
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	337 <directive name="server_name">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	338 <syntax><value>name</value></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	339 <default>hostname</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	340 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	341 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	342
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	343 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	344 Sets the server name that is used:
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	345 <list type="bullet">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	346
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	347 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	348 in the initial POP3/SMTP server greeting;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	349 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	350
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	351 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	352 in the salt during the SASL CRAM-MD5 authentication;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	353 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	354
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	355 <listitem>
1070 73b31b44d3a0 Updated and simplified the "xclient" directive description. Sergey Kandaurov <pluknet@nginx.com> parents: 1069 diff changeset	356 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	357 if the passing of the
73b31b44d3a0 Updated and simplified the "xclient" directive description. Sergey Kandaurov <pluknet@nginx.com> parents: 1069 diff changeset	358 <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	359 is enabled.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	360 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	361
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	362 </list>
1069 71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	363 </para>
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	364
1069 71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	365 <para>
71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	366 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	367 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	368
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	369 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	370
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	371
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	372 <directive name="timeout">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	373 <syntax><value>time</value></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	374 <default>60s</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	375 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	376 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	377
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	378 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	379 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	380 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	381
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	382 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	383
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	384 </section>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	385
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	386 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/mail/ngx_mail_core_module.xml @ 1502:b628e042a15e