diff xml/en/docs/mail/ngx_mail_proxy_module.xml @ 2614:1f8f12a32ecd

Documented the proxy_smtp_auth directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 23 Oct 2020 18:57:14 +0100
parents 7b15698cbdb7
children a4d3e6db81b9
line wrap: on
line diff
--- a/xml/en/docs/mail/ngx_mail_proxy_module.xml	Tue Oct 20 14:38:38 2020 +0100
+++ b/xml/en/docs/mail/ngx_mail_proxy_module.xml	Fri Oct 23 18:57:14 2020 +0100
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_proxy_module"
         link="/en/docs/mail/ngx_mail_proxy_module.html"
         lang="en"
-        rev="3">
+        rev="4">
 
 <section id="directives" name="Directives">
 
@@ -75,6 +75,27 @@
 </directive>
 
 
+<directive name="proxy_smtp_auth">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>mail</context>
+<context>server</context>
+<appeared-in>1.19.4</appeared-in>
+
+<para>
+Enables or disables user authentication on the SMTP backend
+using the <literal>AUTH</literal> command.
+</para>
+
+<para>
+If <link id="xclient">XCLIENT</link> is also enabled,
+then the <literal>XCLIENT</literal> command will not send
+the <literal>LOGIN</literal> parameter.
+</para>
+
+</directive>
+
+
 <directive name="proxy_timeout">
 <syntax><value>timeout</value></syntax>
 <default>24h</default>