Mercurial > hg > nginx-site

comparison xml/en/docs/mail/ngx_mail_imap_module.xml @ 664:8283b1048b27

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Translated mail modules into English.
author Vladimir Homutov <vl@nginx.com>
date Wed, 05 Sep 2012 14:07:43 +0000
parents
children 95c3c3bbf1ce
comparison
equal deleted inserted replaced
663:639bbb0c9d05 664:8283b1048b27
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) 2006, 2007 Anton Yuzhaninov
5 Copyright (C) Nginx, Inc.
6 -->
7
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9
10 <module name="Module ngx_mail_imap_module"
11 link="/en/docs/mail/ngx_mail_imap_module.html"
12 lang="en"
13 rev="1">
14
15 <section id="directives" name="Directives">
16
17 <directive name="imap_auth">
18 <syntax><value>method</value> ...</syntax>
19 <default>plain</default>
20 <context>mail</context>
21 <context>server</context>
22
23 <para>
24 Sets permitted methods of authentication for IMAP clients.
25 Supported methods are:
26 <list type="tag">
27
28 <tag-name><literal>login</literal></tag-name>
29 <tag-desc>
30 <link url="http://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH=LOGIN</link>
31 </tag-desc>
32
33 <tag-name><literal>plain</literal></tag-name>
34 <tag-desc>
35 <link url="http://tools.ietf.org/html/rfc4616">AUTH=PLAIN</link>
36 </tag-desc>
37
38 <tag-name><literal>cram-md5</literal></tag-name>
39 <tag-desc>
40 <link url="http://tools.ietf.org/html/rfc2195">AUTH=CRAM-MD5</link>.
41 In order for this method to work, the password must be stored unencrypted.
42 </tag-desc>
43
44 </list>
45 </para>
46
47 </directive>
48
49
50 <directive name="imap_capabilities">
51 <syntax><value>extension</value> ...</syntax>
52 <default>IMAP4 IMAP4rev1 UIDPLUS</default>
53 <context>mail</context>
54 <context>server</context>
55
56 <para>
57 Allows to specify the
58 <link url="http://tools.ietf.org/html/rfc3501">IMAP protocol</link>
59 extensions list to be passed to the client upon
60 issuing the <literal>CAPABILITY</literal> command.
61 Authentication methods specified in the <link id="imap_auth"/> and
62 <link url="http://tools.ietf.org/html/rfc2595">STARTTLS</link> directives
63 are automatically added to this list if the
64 <link doc="ngx_mail_ssl_module.xml" id="starttls"/> directive is enabled.
65 </para>
66
67 <para>
68 It makes sense to specify extensions
69 supported by IMAP backends
70 to which clients are proxied (if this extensions are related to commands
71 used after the authentication, when nginx transparently proxies the client
72 connection to the backend).
73 </para>
74
75 <para>
76 The current list of standardized extensions is published at the
77 <link url="http://www.iana.org/assignments/imap4-capabilities">www.iana.org</link>.
78 </para>
79
80 </directive>
81
82
83 <directive name="imap_client_buffer">
84 <syntax><value>size</value></syntax>
85 <default>4k|8k</default>
86 <context>mail</context>
87 <context>server</context>
88
89 <para>
90 Sets the IMAP commands read buffer size.
91 By default, the buffer size is equal to one memory page.
92 This is either 4K or 8K, depending on a platform.
93 </para>
94
95 </directive>
96
97 </section>
98
99 </module>