Mercurial > hg > nginx-site

annotate xml/ru/docs/mail/ngx_mail_imap_module.xml @ 3090:27532d42102b default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented the "rate" parameter of the "error_log" directive.
author Maxim Dounin <mdounin@mdounin.ru>
date Sun, 16 Jun 2024 06:55:30 +0300
parents 7b7dbaa7d777
children
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"
3088
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
13 rev="8">
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
2736
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2102
diff changeset
28 <tag-name><literal>plain</literal></tag-name>
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2102
diff changeset
29 <tag-desc>
2831
4add6ae1296f Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2737
diff changeset
30 <link url="https://datatracker.ietf.org/doc/html/rfc3501">LOGIN</link>,
4add6ae1296f Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2737
diff changeset
31 <link url="https://datatracker.ietf.org/doc/html/rfc4616">AUTH=PLAIN</link>
2736
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2102
diff changeset
32 </tag-desc>
48004177276d Reordered methods in imap_auth and smtp_auth.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2102
diff changeset
33
641
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
34 <tag-name><literal>login</literal></tag-name>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
35 <tag-desc>
2831
4add6ae1296f Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2737
diff changeset
36 <link url="https://datatracker.ietf.org/doc/html/draft-murchison-sasl-login-00">AUTH=LOGIN</link>
641
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
37 </tag-desc>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
38
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
39 <tag-name><literal>cram-md5</literal></tag-name>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
40 <tag-desc>
2831
4add6ae1296f Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2737
diff changeset
41 <link url="https://datatracker.ietf.org/doc/html/rfc2195">AUTH=CRAM-MD5</link>.
641
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
42 Для работы этого метода пароль должен храниться в незашифрованном виде.
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
43 </tag-desc>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
44
1887
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 641
diff changeset
45 <tag-name><literal>external</literal></tag-name>
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 641
diff changeset
46 <tag-desc>
2831
4add6ae1296f Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2737
diff changeset
47 <link url="https://datatracker.ietf.org/doc/html/rfc4422">AUTH=EXTERNAL</link> (1.11.6).
1887
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 641
diff changeset
48 </tag-desc>
9af1e88e10c8 Documented SASL EXTERNAL support in mail.
Sergey Kandaurov <pluknet@nginx.com>
parents: 641
diff changeset
49
3088
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
50 <tag-name><literal>xoauth2</literal></tag-name>
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
51 <tag-desc>
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
52 <link url="https://developers.google.com/gmail/imap/xoauth2-protocol"
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
53 >AUTH=XOAUTH2</link> (1.27.1).
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
54 </tag-desc>
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
55
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
56 <tag-name><literal>oauthbearer</literal></tag-name>
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
57 <tag-desc>
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
58 <link url="https://datatracker.ietf.org/doc/html/rfc7628"
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
59 >AUTH=OAUTHBEARER</link> (1.27.1).
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
60 </tag-desc>
7b7dbaa7d777 Documented XOAUTH2 and OAUTHBEARER authentication methods.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2831
diff changeset
61
641
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
62 </list>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
63 </para>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
64
2737
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
65 <para>
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
66 Методы аутентификации с передачей пароля открытым текстом
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
67 (команда <literal>LOGIN</literal>, <literal>AUTH=PLAIN</literal>
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
68 и <literal>AUTH=LOGIN</literal>) включены всегда,
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
69 однако если методы <literal>plain</literal> и <literal>login</literal>
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
70 не указаны, то
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
71 <literal>AUTH=PLAIN</literal> и <literal>AUTH=LOGIN</literal>
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
72 не будут автоматически добавляться в <link id="imap_capabilities"/>.
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
73 </para>
9986e1f25cd7 Improved pop3_auth, imap_auth, and smtp_auth descriptions.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2736
diff changeset
74
641
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
75 </directive>
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
76
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
77
637
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 <directive name="imap_capabilities">
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79 <syntax><value>расширение</value> ...</syntax>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 <default>IMAP4 IMAP4rev1 UIDPLUS</default>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 <context>mail</context>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82 <context>server</context>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 <para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 Позволяет указать список расширений
2831
4add6ae1296f Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2737
diff changeset
86 <link url="https://datatracker.ietf.org/doc/html/rfc3501">протокола IMAP</link>,
637
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 <literal>CAPABILITY</literal>.
1924
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
89 В зависимости от значения директивы
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
90 <link doc="ngx_mail_ssl_module.xml" id="starttls"/>
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
91 к этому списку автоматически добавляются
237a10fb98d2 Clarified imap/pop3/smtp_capabilities and starttls interaction.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
92 методы аутентификации, указанные в директиве <link id="imap_auth"/>, и
2831
4add6ae1296f Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2737
diff changeset
93 <link url="https://datatracker.ietf.org/doc/html/rfc2595">STARTTLS</link>.
637
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
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 <para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 В данной директиве имеет смысл указать расширения,
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98 поддерживаемые IMAP-бэкендами,
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99 на которые проксируются клиенты (если эти расширения относятся к командам,
641
Ruslan Ermilov <ru@nginx.com>
parents: 637
diff changeset
100 используемым после аутентификации, когда nginx прозрачно проксирует подключение
637
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 </para>
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 <para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105 Текущий список стандартизованных расширений опубликован на
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106 <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
107 </para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 </directive>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 <directive name="imap_client_buffer">
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 <syntax><value>размер</value></syntax>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 <default>4k|8k</default>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 <context>mail</context>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 <context>server</context>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118 <para>
2102
d7f34859645b Matched wording of imap_client_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1924
diff changeset
119 Задаёт <value>размер</value> буфера для чтения IMAP-команд.
637
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 По умолчанию размер одного буфера равен размеру страницы.
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 В зависимости от платформы это или 4K, или 8K.
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122 </para>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124 </directive>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126 </section>
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127
9a85069172dc IMAP/POP3/SMTP directives split into their own modules.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 </module>