annotate xml/ru/docs/mail/ngx_mail_imap_module.xml @ 1887:9af1e88e10c8

Documented SASL EXTERNAL support in mail.
author Sergey Kandaurov <pluknet@nginx.com>
date Mon, 16 Jan 2017 12:33:15 +0300
parents ca72f350f6f0
children 66a30a380fba
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
637
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
3 <!--
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
4 Copyright (C) 2006, 2007 Anton Yuzhaninov
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
5 Copyright (C) Nginx, Inc.
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
6 -->
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Модуль ngx_mail_imap_module"
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/ru/docs/mail/ngx_mail_imap_module.html"
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
12 lang="ru"
1887
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 641
diff changeset
13 rev="2">
637
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <section id="directives" name="Директивы">
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16
641
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
17 <directive name="imap_auth">
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
18 <syntax><value>метод</value> ...</syntax>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
19 <default>plain</default>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
20 <context>mail</context>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
21 <context>server</context>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
22
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
23 <para>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
24 Задаёт разрешённые методы аутентификации IMAP-клиентов.
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
25 Поддерживаемые методы:
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
26 <list type="tag">
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
27
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
28 <tag-name><literal>login</literal></tag-name>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
29 <tag-desc>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
30 <link url="http://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH=LOGIN</link>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
31 </tag-desc>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
32
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
33 <tag-name><literal>plain</literal></tag-name>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
34 <tag-desc>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
35 <link url="http://tools.ietf.org/html/rfc4616">AUTH=PLAIN</link>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
36 </tag-desc>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
37
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
38 <tag-name><literal>cram-md5</literal></tag-name>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
39 <tag-desc>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
40 <link url="http://tools.ietf.org/html/rfc2195">AUTH=CRAM-MD5</link>.
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
41 Для работы этого метода пароль должен храниться в незашифрованном виде.
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
42 </tag-desc>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
43
1887
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 641
diff changeset
44 <tag-name><literal>external</literal></tag-name>
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 641
diff changeset
45 <tag-desc>
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 641
diff changeset
46 <link url="http://tools.ietf.org/html/rfc4422">AUTH=EXTERNAL</link> (1.11.6).
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 641
diff changeset
47 </tag-desc>
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 641
diff changeset
48
641
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
49 </list>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
50 </para>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
51
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
52 </directive>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
53
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
54
637
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 <directive name="imap_capabilities">
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 <syntax><value>расширение</value> ...</syntax>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 <default>IMAP4 IMAP4rev1 UIDPLUS</default>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 <context>mail</context>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 <context>server</context>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 <para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 Позволяет указать список расширений
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 <link url="http://tools.ietf.org/html/rfc3501">протокола IMAP</link>,
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 выдаваемый клиенту по команде
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 <literal>CAPABILITY</literal>.
641
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
66 К этому списку автоматически добавляются
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
67 методы аутентификации, указанные в директиве <link id="imap_auth"/> и
637
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 <link url="http://tools.ietf.org/html/rfc2595">STARTTLS</link>,
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 если включена директива <link doc="ngx_mail_ssl_module.xml" id="starttls"/>.
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 </para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 <para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73 В данной директиве имеет смысл указать расширения,
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 поддерживаемые IMAP-бэкендами,
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 на которые проксируются клиенты (если эти расширения относятся к командам,
641
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
76 используемым после аутентификации, когда nginx прозрачно проксирует подключение
637
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 клиента на бэкенд).
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 </para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 <para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 Текущий список стандартизованных расширений опубликован на
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82 <link url="http://www.iana.org/assignments/imap4-capabilities">www.iana.org</link>.
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 </para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 </directive>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 <directive name="imap_client_buffer">
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89 <syntax><value>размер</value></syntax>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 <default>4k|8k</default>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 <context>mail</context>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 <context>server</context>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 <para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 Задаёт размер буфера для чтения IMAP-команд.
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 По умолчанию размер одного буфера равен размеру страницы.
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 В зависимости от платформы это или 4K, или 8K.
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98 </para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 </directive>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 </section>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 </module>