changeset 1924:237a10fb98d2

Clarified imap/pop3/smtp_capabilities and starttls interaction.
author Sergey Kandaurov <pluknet@nginx.com>
date Mon, 06 Mar 2017 17:01:22 +0300
parents 66a30a380fba
children a58b35cc0823
files xml/en/docs/mail/ngx_mail_imap_module.xml xml/en/docs/mail/ngx_mail_pop3_module.xml xml/en/docs/mail/ngx_mail_smtp_module.xml xml/en/docs/mail/ngx_mail_ssl_module.xml xml/ru/docs/mail/ngx_mail_imap_module.xml xml/ru/docs/mail/ngx_mail_pop3_module.xml xml/ru/docs/mail/ngx_mail_smtp_module.xml xml/ru/docs/mail/ngx_mail_ssl_module.xml
diffstat 8 files changed, 37 insertions(+), 31 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/mail/ngx_mail_imap_module.xml
+++ b/xml/en/docs/mail/ngx_mail_imap_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_imap_module"
         link="/en/docs/mail/ngx_mail_imap_module.html"
         lang="en"
-        rev="3">
+        rev="4">
 
 <section id="directives" name="Directives">
 
@@ -63,10 +63,10 @@ Sets the
 <link url="https://tools.ietf.org/html/rfc3501">IMAP protocol</link>
 extensions list that is passed to the client in response to
 the <literal>CAPABILITY</literal> command.
-The authentication methods specified in the <link id="imap_auth"/> and
-<link url="https://tools.ietf.org/html/rfc2595">STARTTLS</link> directives
-are automatically added to this list if the
-<link doc="ngx_mail_ssl_module.xml" id="starttls"/> directive is enabled.
+The authentication methods specified in the <link id="imap_auth"/> directive and
+<link url="https://tools.ietf.org/html/rfc2595">STARTTLS</link>
+are automatically added to this list depending on the
+<link doc="ngx_mail_ssl_module.xml" id="starttls"/> directive value.
 </para>
 
 <para>
--- a/xml/en/docs/mail/ngx_mail_pop3_module.xml
+++ b/xml/en/docs/mail/ngx_mail_pop3_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_pop3_module"
         link="/en/docs/mail/ngx_mail_pop3_module.html"
         lang="en"
-        rev="3">
+        rev="4">
 
 <section id="directives" name="Directives">
 
@@ -67,12 +67,11 @@ Sets the
 <link url="https://tools.ietf.org/html/rfc2449">POP3 protocol</link>
 extensions list that is passed to the client in response to
 the <literal>CAPA</literal> command.
-
-The authentication methods specified in the <link id="pop3_auth"/> and
+The authentication methods specified in the <link id="pop3_auth"/> directive
 (<link url="https://tools.ietf.org/html/rfc2449">SASL</link> extension) and
-<link url="https://tools.ietf.org/html/rfc2595">STLS</link> directives,
-are automatically added to this list if the
-<link doc="ngx_mail_ssl_module.xml" id="starttls"/> directive is enabled.
+<link url="https://tools.ietf.org/html/rfc2595">STLS</link>
+are automatically added to this list depending on the
+<link doc="ngx_mail_ssl_module.xml" id="starttls"/> directive value.
 </para>
 
 <para>
--- a/xml/en/docs/mail/ngx_mail_smtp_module.xml
+++ b/xml/en/docs/mail/ngx_mail_smtp_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_smtp_module"
         link="/en/docs/mail/ngx_mail_smtp_module.html"
         lang="en"
-        rev="4">
+        rev="5">
 
 <section id="directives" name="Directives">
 
@@ -69,8 +69,10 @@ Authentication is not required.
 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.
+The authentication methods specified in the <link id="smtp_auth"/> directive and
+<link url="https://tools.ietf.org/html/rfc3207">STARTTLS</link>
+are automatically added to this list depending on the
+<link doc="ngx_mail_ssl_module.xml" id="starttls"/> directive value.
 </para>
 
 <para>
--- a/xml/en/docs/mail/ngx_mail_ssl_module.xml
+++ b/xml/en/docs/mail/ngx_mail_ssl_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_ssl_module"
         link="/en/docs/mail/ngx_mail_ssl_module.html"
         lang="en"
-        rev="14">
+        rev="15">
 
 <section id="summary">
 
@@ -573,7 +573,7 @@ Sets the verification depth in the clien
 <tag-name><literal>on</literal></tag-name>
 <tag-desc>
 allow usage of the <literal>STLS</literal> command for the POP3
-and the <literal>STARTTLS</literal> command for the IMAP;
+and the <literal>STARTTLS</literal> command for the IMAP and SMTP;
 </tag-desc>
 
 <tag-name><literal>off</literal></tag-name>
--- a/xml/ru/docs/mail/ngx_mail_imap_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_imap_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_imap_module"
         link="/ru/docs/mail/ngx_mail_imap_module.html"
         lang="ru"
-        rev="3">
+        rev="4">
 
 <section id="directives" name="Директивы">
 
@@ -63,10 +63,11 @@
 <link url="https://tools.ietf.org/html/rfc3501">протокола IMAP</link>,
 выдаваемый клиенту по команде
 <literal>CAPABILITY</literal>.
-К этому списку автоматически добавляются
-методы аутентификации, указанные в директиве <link id="imap_auth"/> и
-<link url="https://tools.ietf.org/html/rfc2595">STARTTLS</link>,
-если включена директива <link doc="ngx_mail_ssl_module.xml" id="starttls"/>.
+В зависимости от значения директивы
+<link doc="ngx_mail_ssl_module.xml" id="starttls"/>
+к этому списку автоматически добавляются
+методы аутентификации, указанные в директиве <link id="imap_auth"/>, и
+<link url="https://tools.ietf.org/html/rfc2595">STARTTLS</link>.
 </para>
 
 <para>
--- a/xml/ru/docs/mail/ngx_mail_pop3_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_pop3_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_pop3_module"
         link="/ru/docs/mail/ngx_mail_pop3_module.html"
         lang="ru"
-        rev="3">
+        rev="4">
 
 <section id="directives" name="Директивы">
 
@@ -67,11 +67,12 @@
 <link url="https://tools.ietf.org/html/rfc2449">протокола POP3</link>,
 выдаваемый клиенту по команде
 <literal>CAPA</literal>.
-К этому списку автоматически добавляются
+В зависимости от значения директивы
+<link doc="ngx_mail_ssl_module.xml" id="starttls"/>
+к этому списку автоматически добавляются
 методы аутентификации, указанные в директиве <link id="pop3_auth"/>
-(расширение <link url="https://tools.ietf.org/html/rfc2449">SASL</link>) и
-<link url="https://tools.ietf.org/html/rfc2595">STLS</link>,
-если включена директива <link doc="ngx_mail_ssl_module.xml" id="starttls"/>.
+(расширение <link url="https://tools.ietf.org/html/rfc2449">SASL</link>), и
+<link url="https://tools.ietf.org/html/rfc2595">STLS</link>.
 </para>
 
 <para>
--- a/xml/ru/docs/mail/ngx_mail_smtp_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_smtp_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_smtp_module"
         link="/ru/docs/mail/ngx_mail_smtp_module.html"
         lang="ru"
-        rev="4">
+        rev="5">
 
 <section id="directives" name="Директивы">
 
@@ -69,8 +69,11 @@ SMTP-клиентов.
 Позволяет указать список расширений протокола SMTP,
 выдаваемый клиенту в ответе на команду
 <literal>EHLO</literal>.
-К этому списку автоматически добавляются
-методы аутентификации, указанные в директиве <link id="smtp_auth"/>.
+В зависимости от значения директивы
+<link doc="ngx_mail_ssl_module.xml" id="starttls"/>
+к этому списку автоматически добавляются
+методы аутентификации, указанные в директиве <link id="smtp_auth"/>, и
+<link url="https://tools.ietf.org/html/rfc3207">STARTTLS</link>.
 </para>
 
 <para>
--- a/xml/ru/docs/mail/ngx_mail_ssl_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_ssl_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_ssl_module"
         link="/ru/docs/mail/ngx_mail_ssl_module.html"
         lang="ru"
-        rev="14">
+        rev="15">
 
 <section id="summary">
 
@@ -573,7 +573,7 @@ AES256 (для 80-байтных ключей, 1.11.8), либо AES128 (для 48-байтных ключей).
 <tag-name><literal>on</literal></tag-name>
 <tag-desc>
 разрешить использование команд <literal>STLS</literal> для POP3
-и <literal>STARTTLS</literal> для IMAP;
+и <literal>STARTTLS</literal> для IMAP и SMTP;
 </tag-desc>
 
 <tag-name><literal>off</literal></tag-name>