<?xml version="1.0"?>

<!--
  Copyright (C) 2006, 2007 Anton Yuzhaninov
  Copyright (C) Nginx, Inc.
  -->

<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">

<module name="Module ngx_mail_smtp_module"
        link="/en/docs/mail/ngx_mail_smtp_module.html"
        lang="en"
        rev="4">

<section id="directives" name="Directives">

<directive name="smtp_auth">
<syntax><value>method</value> ...</syntax>
<default>login plain</default>
<context>mail</context>
<context>server</context>

<para>
Sets permitted methods of
<link url="https://tools.ietf.org/html/rfc2554">SASL authentication</link>
for SMTP clients.
Supported methods are:
<list type="tag">

<tag-name><literal>login</literal></tag-name>
<tag-desc>
<link url="https://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link>
</tag-desc>

<tag-name><literal>plain</literal></tag-name>
<tag-desc>
<link url="https://tools.ietf.org/html/rfc4616">AUTH PLAIN</link>
</tag-desc>

<tag-name><literal>cram-md5</literal></tag-name>
<tag-desc>
<link url="https://tools.ietf.org/html/rfc2195">AUTH CRAM-MD5</link>.
In order for this method to work, the password must be stored unencrypted.
</tag-desc>

<tag-name><literal>external</literal></tag-name>
<tag-desc>
<link url="https://tools.ietf.org/html/rfc4422">AUTH EXTERNAL</link> (1.11.6).
</tag-desc>

<tag-name><literal>none</literal></tag-name>
<tag-desc>
Authentication is not required.
</tag-desc>

</list>
</para>

</directive>


<directive name="smtp_capabilities">
<syntax><value>extension</value> ...</syntax>
<default/>
<context>mail</context>
<context>server</context>

<para>
Sets the SMTP protocol extensions list
that is passed to the client in response to the
<literal>EHLO</literal> command.
Authentication methods specified in the <link id="smtp_auth"/> directive
are automatically added to this list.
</para>

<para>
It makes sense to specify the extensions
supported by the MTA
to which the clients are proxied (if these extensions are related to commands
used after the authentication, when nginx transparently proxies the client
connection to the backend).
</para>

<para>
The current list of standardized extensions is published at
<link url="http://www.iana.org/assignments/mail-parameters">www.iana.org</link>.
</para>

</directive>

</section>

</module>