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

annotate xml/en/docs/mail/ngx_mail_core_module.xml @ 1528:3ae5301ea37a

Added the "events" section to examples of stream and mail.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Thu, 02 Jul 2015 14:12:22 +0300
parents	b628e042a15e
children	f024ac0ec5c7

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"
1528 3ae5301ea37a Added the "events" section to examples of stream and mail. Yaroslav Zhuravlev <yar@nginx.com> parents: 1502 diff changeset	13 rev="8">
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>]
1488 0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	82 [<literal>bind</literal>]
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	83 [<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	84 [<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	85 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	86 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	87
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	88 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	89 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	90 on which the server will accept requests.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	91 It is possible to specify just the port.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	92 The address can also be a hostname, for example:
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	93 <example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	94 listen 127.0.0.1:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	95 listen *:110;
761 84740807c806 Translated commentary in Russian in the English part of documentation. Vladimir Homutov <vl@nginx.com> parents: 751 diff changeset	96 listen 110; # same as *:110
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	97 listen localhost:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	98 </example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	99 IPv6 addresses (0.7.58) are specified in square brackets:
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 listen [::1]:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	102 listen [::]:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	103 </example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	104 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	105 prefix:
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	106 <example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	107 listen unix:/var/run/nginx.sock;
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
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	110 </para>
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>
1489 9f9b8543b946 Relocated phrase in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1488 diff changeset	113 Different servers must listen on different
9f9b8543b946 Relocated phrase in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1488 diff changeset	114 <value>address</value>:<value>port</value> pairs.
9f9b8543b946 Relocated phrase in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1488 diff changeset	115 </para>
9f9b8543b946 Relocated phrase in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1488 diff changeset	116
9f9b8543b946 Relocated phrase in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1488 diff changeset	117 <para>
1488 0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	118 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	119 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	120 </para>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	121
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 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	124 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	125 <list type="tag">
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	126
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	127 <tag-name>
1502 b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	128 <literal>backlog</literal>=<value>number</value>
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	129 </tag-name>
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	130 <tag-desc>
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	131 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	132 <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	133 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	134 By default,
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	135 <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	136 and to 511 on other platforms.
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	137 </tag-desc>
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	138
b628e042a15e Documented "listen backlog=" in mail and stream. Ruslan Ermilov <ru@nginx.com> parents: 1489 diff changeset	139 <tag-name>
1488 0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	140 <literal>bind</literal>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	141 </tag-name>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	142 <tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	143 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	144 call for a given address:port pair.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	145 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	146 the same port but different addresses, and one of the
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	147 <literal>listen</literal> directives listens on all addresses
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	148 for the given port (<literal>*:</literal><value>port</value>), nginx will
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	149 <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	150 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	151 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	152 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	153 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	154 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	155 <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	156 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	157 </tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	158
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 <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	161 </tag-name>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	162 <tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	163 this parameter determines
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	164 (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	165 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	166 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	167 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	168 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	169 </tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	170
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	171 <tag-name>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	172 <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	173 </tag-name>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	174 <tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	175 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	176 for the listening socket.
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	177 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	178 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	179 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	180 <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	181 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	182 <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	183 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	184 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	185 <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	186 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	187 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	188 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	189 <value>keepcnt</value> parameters.
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	190 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	191 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	192 For example,
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	193 <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	194 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	195 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	196 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	197 </tag-desc>
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	198
0a1c5a087556 Documented bind/ipv6only/ssl/so_keepalive in mail listen directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1471 diff changeset	199 </list>
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	200 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	201
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	202 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	203
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	204
748 95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	205 <directive name="mail">
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	206 <syntax block="yes"/>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	207 <default/>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	208 <context>main</context>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	209
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	210 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	211 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	212 are specified.
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	213 </para>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	214
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	215 </directive>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	216
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	217
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	218 <directive name="protocol">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	219 <syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	220 <literal>imap</literal> \|
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	221 <literal>pop3</literal> \|
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	222 <literal>smtp</literal></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	223 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	224 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	225
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	226 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	227 Sets the protocol for a proxied server.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	228 Supported protocols are
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	229 <link doc="ngx_mail_imap_module.xml">IMAP</link>,
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	230 <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	231 <link doc="ngx_mail_smtp_module.xml">SMTP</link>.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	232 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	233
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	234 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	235 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	236 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	237 directive:
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	238 <list type="bullet">
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>imap</literal>: 143, 993
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>pop3</literal>: 110, 995
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 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	249 <literal>smtp</literal>: 25, 587, 465
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	250 </listitem>
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 </list>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	253 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	254
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	255 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	256 Unnecessary protocols can be disabled using the
924 a2aea48ff155 New "installation" article. Ruslan Ermilov <ru@nginx.com> parents: 761 diff changeset	257 <link doc="../configure.xml">configuration</link>
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	258 parameters <literal>--without-mail_imap_module</literal>,
1046 b81ad8234f90 Minor assorted fixes. Sergey Kandaurov <pluknet@nginx.com> parents: 966 diff changeset	259 <literal>--without-mail_pop3_module</literal>, and
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	260 <literal>--without-mail_smtp_module</literal>.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	261 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	262
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	263 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	264
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	265
1068 0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	266 <directive name="resolver">
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	267 <syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	268 <value>address</value> ...
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	269 [<literal>valid</literal>=<value>time</value>]</syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	270 <syntax><literal>off</literal></syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	271 <default>off</default>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	272 <context>mail</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	273 <context>server</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	274
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	275 <para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	276 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	277 to pass it to the
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	278 <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	279 and in the
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	280 <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	281 command when proxying SMTP.
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	282 For example:
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	283 <example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	284 resolver 127.0.0.1 [::1]:5353;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	285 </example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	286 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	287 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	288 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	289 Name servers are queried in a round-robin fashion.
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 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	292 Specifying name servers using IPv6 addresses is supported
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	293 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	294 </note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	295 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	296 An optional <literal>valid</literal> parameter allows overriding it:
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	297 <example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	298 resolver 127.0.0.1 [::1]:5353 valid=30s;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	299 </example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	300 <note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	301 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	302 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	303 </note>
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 <para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	307 The special value <literal>off</literal> disables resolving.
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	308 </para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	309
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	310 </directive>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	311
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	312
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	313 <directive name="resolver_timeout">
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	314 <syntax><value>time</value></syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	315 <default>30s</default>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	316 <context>mail</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	317 <context>server</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	318
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	319 <para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	320 Sets a timeout for DNS operations, for example:
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	321 <example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	322 resolver_timeout 5s;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	323 </example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	324 </para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	325
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	326 </directive>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	327
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	328
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	329 <directive name="server">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	330 <syntax block="yes"/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	331 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	332 <context>mail</context>
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 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	335 Sets the configuration for a server.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	336 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	337
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	338 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	339
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	340
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	341 <directive name="server_name">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	342 <syntax><value>name</value></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	343 <default>hostname</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	344 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	345 <context>server</context>
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 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	348 Sets the server name that is used:
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	349 <list type="bullet">
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 initial POP3/SMTP server greeting;
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>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	356 in the salt during the SASL CRAM-MD5 authentication;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	357 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	358
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	359 <listitem>
1070 73b31b44d3a0 Updated and simplified the "xclient" directive description. Sergey Kandaurov <pluknet@nginx.com> parents: 1069 diff changeset	360 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	361 if the passing of the
73b31b44d3a0 Updated and simplified the "xclient" directive description. Sergey Kandaurov <pluknet@nginx.com> parents: 1069 diff changeset	362 <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	363 is enabled.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	364 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	365
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	366 </list>
1069 71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	367 </para>
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	368
1069 71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	369 <para>
71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	370 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	371 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	372
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	373 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	374
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	375
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	376 <directive name="timeout">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	377 <syntax><value>time</value></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	378 <default>60s</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 <context>server</context>
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 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	383 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	384 </para>
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 </directive>
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 </section>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	389
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	390 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/mail/ngx_mail_core_module.xml @ 1528:3ae5301ea37a