Mercurial > hg > nginx-site

comparison xml/en/docs/mail/ngx_mail_pop3_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_pop3_module"
11 link="/en/docs/mail/ngx_mail_pop3_module.html"
12 lang="en"
13 rev="1">
14
15 <section id="directives" name="Directives">
16
17 <directive name="pop3_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 POP3 clients.
25 Supported methods are:
26 <list type="tag">
27
28 <tag-name><literal>plain</literal></tag-name>
29 <tag-desc>
30 <link url="http://tools.ietf.org/html/rfc1939">USER/PASS</link>,
31 <link url="http://tools.ietf.org/html/rfc4616">AUTH PLAIN</link>,
32 <link url="http://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link>.
33 It is not possible to disable this methods.
34 </tag-desc>
35
36 <tag-name><literal>apop</literal></tag-name>
37 <tag-desc>
38 <link url="http://tools.ietf.org/html/rfc1939">APOP</link>.
39 In order for this method to work, the password must be stored unencrypted.
40 </tag-desc>
41
42 <tag-name><literal>cram-md5</literal></tag-name>
43 <tag-desc>
44 <link url="http://tools.ietf.org/html/rfc2195">AUTH CRAM-MD5</link>.
45 In order for this method to work, the password must be stored unencrypted.
46 </tag-desc>
47
48 </list>
49 </para>
50
51 </directive>
52
53
54 <directive name="pop3_capabilities">
55 <syntax><value>extension</value> ...</syntax>
56 <default>TOP USER UIDL</default>
57 <context>mail</context>
58 <context>server</context>
59
60 <para>
61 Allows to specify the
62 <link url="http://tools.ietf.org/html/rfc2449">POP3 protocol</link>
63 extensions list to be passed to the client upon
64 issuing the <literal>CAPA</literal> command.
65
66 Authentication methods specified in the <link id="pop3_auth"/> and
67 (<link url="http://tools.ietf.org/html/rfc2449">SASL</link> extension) and
68 <link url="http://tools.ietf.org/html/rfc2595">STLS</link> directives,
69 are automatically added to this list if the
70 <link doc="ngx_mail_ssl_module.xml" id="starttls"/> directive is enabled.
71 </para>
72
73 <para>
74 It makes sense to specify extensions
75 supported by POP3 backends
76 to which clients are proxied (if this extensions are related to commands
77 used after the authentication, when nginx transparently proxies the client
78 connection to the backend).
79 </para>
80
81 <para>
82 The current list of standardized extensions is published at the
83 <link url="http://www.iana.org/assignments/pop3-extension-mechanism">www.iana.org</link>.
84 </para>
85
86 </directive>
87
88 </section>
89
90 </module>