comparison xml/en/docs/mail/ngx_mail_auth_http_module.xml @ 1066:de77e295c073

Documented the "Auth-User" authentication header field.
author Sergey Kandaurov <pluknet@nginx.com>
date Sat, 08 Feb 2014 17:42:40 +0400
parents 88c0d96b9825
children f49e326758c0
comparison
equal deleted inserted replaced
1065:88c0d96b9825 1066:de77e295c073
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_mail_auth_http_module" 10 <module name="Module ngx_mail_auth_http_module"
11 link="/en/docs/mail/ngx_mail_auth_http_module.html" 11 link="/en/docs/mail/ngx_mail_auth_http_module.html"
12 lang="en" 12 lang="en"
13 rev="1"> 13 rev="2">
14 14
15 <section id="directives" name="Directives"> 15 <section id="directives" name="Directives">
16 16
17 <directive name="auth_http"> 17 <directive name="auth_http">
18 <syntax><value>URL</value></syntax> 18 <syntax><value>URL</value></syntax>
136 Auth-Pass: plain-text-pass 136 Auth-Pass: plain-text-pass
137 </example> 137 </example>
138 </para> 138 </para>
139 139
140 <para> 140 <para>
141 If the <header>Auth-User</header> header exists in a response,
142 it overrides the username used to authenticate with the backend.
143 </para>
144
145 <para>
141 For the SMTP, the response additionally takes into account 146 For the SMTP, the response additionally takes into account
142 the <header>Auth-Error-Code</header> header — if exists, it is used 147 the <header>Auth-Error-Code</header> header — if exists, it is used
143 as a response code in case of an error. 148 as a response code in case of an error.
144 Otherwise, the 535 5.7.0 code will be added to 149 Otherwise, the 535 5.7.0 code will be added to
145 the <header>Auth-Status</header>. 150 the <header>Auth-Status</header>.