Mercurial > hg > nginx-site

annotate xml/en/docs/mail/ngx_mail_auth_http_module.xml @ 1255:e48d4309e7f2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Mail auth: added link to the protocol in the "auth_http" directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 17 Jul 2014 15:21:10 +0400
parents f49e326758c0
children ebfcd76e23b6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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_auth_http_module"
667
81ac18894319 link and lang tags corrected.
Maxim Konovalov <maxim@nginx.com>
parents: 664
diff changeset
11 link="/en/docs/mail/ngx_mail_auth_http_module.html"
81ac18894319 link and lang tags corrected.
Maxim Konovalov <maxim@nginx.com>
parents: 664
diff changeset
12 lang="en"
1255
e48d4309e7f2 Mail auth: added link to the protocol in the "auth_http" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1254
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="directives" name="Directives">
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 <directive name="auth_http">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
18 <syntax><value>URL</value></syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
19 <default/>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
20 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
21 <context>server</context>
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 <para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
24 Sets the URL of the HTTP authentication server.
1255
e48d4309e7f2 Mail auth: added link to the protocol in the "auth_http" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1254
diff changeset
25 The protocol is described <link id="protocol">below</link>.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
26 </para>
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 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
29
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
30
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
31 <directive name="auth_http_header">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
32 <syntax><value>header</value> <value>value</value></syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
33 <default/>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
34 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
35 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
36
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
37 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
38 Appends the specified header to requests to the authentication server.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
39 This header can be used as the shared secret to verify
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
40 that the request comes from nginx.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
41 For example:
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
42 <example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
43 auth_http_header X-Auth-Key "secret_string";
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
44 </example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
45 </para>
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 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
48
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
49
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
50 <directive name="auth_http_timeout">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
51 <syntax><value>time</value></syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
52 <default>60s</default>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
53 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
54 <context>server</context>
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 <para>
1254
f49e326758c0 Mail auth: added description for the "auth_http_timeout" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1066
diff changeset
57 Sets the timeout for communication with the authentication server.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
58 </para>
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 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
61
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
62 </section>
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 <section id="protocol" name="Protocol">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
66
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
67 <para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
68 The HTTP is used to communicate with the authentication server.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
69 The data in the response body is ignored, and the information is passed only in
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
70 the headers.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
71 </para>
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 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
74 Examples of requests and responses:
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
75 </para>
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 <para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
78 Request:
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
79 <example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
80 GET /auth HTTP/1.0
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
81 Host: localhost
1063
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
82 Auth-Method: plain # plain/apop/cram-md5
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
83 Auth-User: user
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
84 Auth-Pass: password
1063
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
85 Auth-Protocol: imap # imap/pop3/smtp
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
86 Auth-Login-Attempt: 1
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
87 Client-IP: 192.0.2.42
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
88 Client-Host: client.example.org
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
89 </example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
90 Good response:
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
91 <example>
1063
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
92 HTTP/1.0 200 OK
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
93 Auth-Status: OK
1063
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
94 Auth-Server: 198.51.100.1
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
95 Auth-Port: 143
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
96 </example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
97 Bad response:
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
98 <example>
1063
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
99 HTTP/1.0 200 OK
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
100 Auth-Status: Invalid login or password
1063
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
101 Auth-Wait: 3
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
102 </example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
103 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
104
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
105 <para>
1046
b81ad8234f90 Minor assorted fixes.
Sergey Kandaurov <pluknet@nginx.com>
parents: 966
diff changeset
106 If there is no <header>Auth-Wait</header> header,
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
107 an error will be returned and the connection will be closed.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
108 The current implementation allocates memory for each authentication attempt.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
109 The memory is freed only at the end of a session.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
110 Therefore, the number of invalid authentication attempts in a single session
1046
b81ad8234f90 Minor assorted fixes.
Sergey Kandaurov <pluknet@nginx.com>
parents: 966
diff changeset
111 must be limited — the server must respond without
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
112 the <header>Auth-Wait</header> header after 10-20 attempts
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
113 (the attempt number is passed in the <header>Auth-Login-Attempt</header>
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
114 header).
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>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
118 When the APOP or CRAM-MD5 are used, a request-response will look as follows.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
119 <example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
120 GET /auth HTTP/1.0
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
121 Host: localhost
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
122 Auth-Method: apop
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
123 Auth-User: user
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
124 Auth-Salt: &lt;238188073.1163692009@mail.example.com&gt;
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
125 Auth-Pass: auth_response
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
126 Auth-Protocol: imap
1063
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
127 Auth-Login-Attempt: 1
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
128 Client-IP: 192.0.2.42
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
129 Client-Host: client.example.org
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
130 </example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
131 Good response:
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
132 <example>
1063
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
133 HTTP/1.0 200 OK
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
134 Auth-Status: OK
1063
6a19aadc15b2 Updates and unification for mail_auth_http_module examples.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1046
diff changeset
135 Auth-Server: 198.51.100.1
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
136 Auth-Port: 143
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
137 Auth-Pass: plain-text-pass
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
138 </example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
139 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
140
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
141 <para>
1066
de77e295c073 Documented the "Auth-User" authentication header field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1065
diff changeset
142 If the <header>Auth-User</header> header exists in a response,
de77e295c073 Documented the "Auth-User" authentication header field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1065
diff changeset
143 it overrides the username used to authenticate with the backend.
de77e295c073 Documented the "Auth-User" authentication header field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1065
diff changeset
144 </para>
de77e295c073 Documented the "Auth-User" authentication header field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1065
diff changeset
145
de77e295c073 Documented the "Auth-User" authentication header field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1065
diff changeset
146 <para>
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
147 For the SMTP, the response additionally takes into account
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
148 the <header>Auth-Error-Code</header> header — if exists, it is used
1064
3ee0ba5f4f08 Updated description of the "Auth-Error-Code" header field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1063
diff changeset
149 as a response code in case of an error.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
150 Otherwise, the 535 5.7.0 code will be added to
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
151 the <header>Auth-Status</header>.
664
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 For example, if the following response is received
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
156 from the authentication server:
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
157 <example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
158 HTTP/1.0 200 OK
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
159 Auth-Status: Temporary server problem, try again later
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
160 Auth-Error-Code: 451 4.3.0
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
161 Auth-Wait: 3
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
162 </example>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 671
diff changeset
163 then the SMTP client will receive an error
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
164 <example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
165 451 4.3.0 Temporary server problem, try again later
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
166 </example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
167 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
168
1065
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
169 <para>
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
170 If proxying SMTP does not require authentication,
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
171 a request will look as follows.
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
172 <example>
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
173 GET /auth HTTP/1.0
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
174 Host: localhost
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
175 Auth-Method: none
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
176 Auth-User:
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
177 Auth-Pass:
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
178 Auth-Protocol: smtp
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
179 Auth-Login-Attempt: 1
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
180 Client-IP: 192.0.2.42
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
181 Client-Host: client.example.org
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
182 Auth-SMTP-Helo: client.example.org
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
183 Auth-SMTP-From: MAIL FROM: &lt;&gt;
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
184 Auth-SMTP-To: RCPT TO: &lt;postmaster@mail.example.com&gt;
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
185 </example>
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
186 </para>
88c0d96b9825 Documented the smtp_auth "none" method.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1064
diff changeset
187
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
188 </section>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
189
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
190 </module>