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

annotate xml/en/docs/mail/ngx_mail_core_module.xml @ 1471:42f288fc9ad3

Removed deprecated directives.

author	Ruslan Ermilov <ru@nginx.com>
date	Wed, 29 Apr 2015 14:02:00 +0300
parents	b0e56cc57867
children	0a1c5a087556

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"
1471 42f288fc9ad3 Removed deprecated directives. Ruslan Ermilov <ru@nginx.com> parents: 1154 diff changeset	13 rev="4">
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>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	76 [<literal>bind</literal>]</syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	77 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	78 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	79
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	80 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	81 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	82 on which the server will accept requests.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	83 It is possible to specify just the port.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	84 The address can also be a hostname, for example:
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	85 <example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	86 listen 127.0.0.1:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	87 listen *:110;
761 84740807c806 Translated commentary in Russian in the English part of documentation. Vladimir Homutov <vl@nginx.com> parents: 751 diff changeset	88 listen 110; # same as *:110
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	89 listen localhost:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	90 </example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	91 IPv6 addresses (0.7.58) are specified in square brackets:
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	92 <example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	93 listen [::1]:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	94 listen [::]:110;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	95 </example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	96 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	97 prefix:
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 listen unix:/var/run/nginx.sock;
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
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	102 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	103
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	104 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	105 The optional <literal>bind</literal> parameter
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	106 instructs to make a separate <c-func>bind</c-func>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	107 call for a given address:port pair.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	108 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	109 the same port but different addresses, and one of the
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	110 <literal>listen</literal> directives listens on all addresses
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	111 for the given port (<literal>*:</literal><value>port</value>), nginx will
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	112 <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	113 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	114 made in this case to determine the address that accepted the connection.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	115 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	116
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	117 <para>
751 9c1ffd02f1b7 Removed "virtual" and HTTPS references from mail modules. Vladimir Homutov <vl@nginx.com> parents: 748 diff changeset	118 Different servers must listen on different
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	119 <value>address</value>:<value>port</value> pairs.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	120 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	121
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	122 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	123
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	124
748 95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	125 <directive name="mail">
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	126 <syntax block="yes"/>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	127 <default/>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	128 <context>main</context>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	129
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	130 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	131 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	132 are specified.
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	133 </para>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	134
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	135 </directive>
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	136
95344046d2d8 Documented 'mail' directive. Vladimir Homutov <vl@nginx.com> parents: 747 diff changeset	137
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	138 <directive name="protocol">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	139 <syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	140 <literal>imap</literal> \|
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	141 <literal>pop3</literal> \|
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	142 <literal>smtp</literal></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	143 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	144 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	145
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	146 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	147 Sets the protocol for a proxied server.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	148 Supported protocols are
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	149 <link doc="ngx_mail_imap_module.xml">IMAP</link>,
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	150 <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	151 <link doc="ngx_mail_smtp_module.xml">SMTP</link>.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	152 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	153
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	154 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	155 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	156 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	157 directive:
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	158 <list type="bullet">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	159
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	160 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	161 <literal>imap</literal>: 143, 993
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	162 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	163
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	164 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	165 <literal>pop3</literal>: 110, 995
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	166 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	167
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	168 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	169 <literal>smtp</literal>: 25, 587, 465
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	170 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	171
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	172 </list>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	173 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	174
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	175 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	176 Unnecessary protocols can be disabled using the
924 a2aea48ff155 New "installation" article. Ruslan Ermilov <ru@nginx.com> parents: 761 diff changeset	177 <link doc="../configure.xml">configuration</link>
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	178 parameters <literal>--without-mail_imap_module</literal>,
1046 b81ad8234f90 Minor assorted fixes. Sergey Kandaurov <pluknet@nginx.com> parents: 966 diff changeset	179 <literal>--without-mail_pop3_module</literal>, and
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	180 <literal>--without-mail_smtp_module</literal>.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	181 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	182
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	183 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	184
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	185
1068 0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	186 <directive name="resolver">
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	187 <syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	188 <value>address</value> ...
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	189 [<literal>valid</literal>=<value>time</value>]</syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	190 <syntax><literal>off</literal></syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	191 <default>off</default>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	192 <context>mail</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	193 <context>server</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	194
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	195 <para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	196 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	197 to pass it to the
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	198 <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	199 and in the
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	200 <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	201 command when proxying SMTP.
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	202 For example:
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	203 <example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	204 resolver 127.0.0.1 [::1]:5353;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	205 </example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	206 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	207 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	208 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	209 Name servers are queried in a round-robin fashion.
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	210 <note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	211 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	212 Specifying name servers using IPv6 addresses is supported
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	213 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	214 </note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	215 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	216 An optional <literal>valid</literal> parameter allows overriding it:
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	217 <example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	218 resolver 127.0.0.1 [::1]:5353 valid=30s;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	219 </example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	220 <note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	221 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	222 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	223 </note>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	224 </para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	225
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	226 <para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	227 The special value <literal>off</literal> disables resolving.
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	228 </para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	229
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	230 </directive>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	231
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	232
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	233 <directive name="resolver_timeout">
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	234 <syntax><value>time</value></syntax>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	235 <default>30s</default>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	236 <context>mail</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	237 <context>server</context>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	238
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	239 <para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	240 Sets a timeout for DNS operations, for example:
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	241 <example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	242 resolver_timeout 5s;
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	243 </example>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	244 </para>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	245
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	246 </directive>
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	247
0c5f8630fe40 Documented the mail "resolver" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1046 diff changeset	248
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	249 <directive name="server">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	250 <syntax block="yes"/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	251 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	252 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	253
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	254 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	255 Sets the configuration for a server.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	256 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	257
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	258 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	259
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 <directive name="server_name">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	262 <syntax><value>name</value></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	263 <default>hostname</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	264 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	265 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	266
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	267 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	268 Sets the server name that is used:
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	269 <list type="bullet">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	270
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	271 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	272 in the initial POP3/SMTP server greeting;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	273 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	274
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	275 <listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	276 in the salt during the SASL CRAM-MD5 authentication;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	277 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	278
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	279 <listitem>
1070 73b31b44d3a0 Updated and simplified the "xclient" directive description. Sergey Kandaurov <pluknet@nginx.com> parents: 1069 diff changeset	280 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	281 if the passing of the
73b31b44d3a0 Updated and simplified the "xclient" directive description. Sergey Kandaurov <pluknet@nginx.com> parents: 1069 diff changeset	282 <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	283 is enabled.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	284 </listitem>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	285
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	286 </list>
1069 71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	287 </para>
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	288
1069 71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	289 <para>
71e6daffa4dc Documented behavior in the absence of the "server_name" directive. Sergey Kandaurov <pluknet@nginx.com> parents: 1068 diff changeset	290 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	291 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	292
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	293 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	294
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	295
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	296 <directive name="timeout">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	297 <syntax><value>time</value></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	298 <default>60s</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	299 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	300 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	301
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	302 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 924 diff changeset	303 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	304 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	305
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	306 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	307
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	308 </section>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	309
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	310 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/mail/ngx_mail_core_module.xml @ 1471:42f288fc9ad3