Mercurial > masqmail-0.2

comparison docs/xml/masqmail.get.5.xml @ 0:08114f7dcc23 0.2.21

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
this is masqmail-0.2.21 from oliver kurth
author meillo@marmaro.de
date Fri, 26 Sep 2008 17:05:23 +0200
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:08114f7dcc23
1 <?xml version="1.0" standalone='no'?>
2 <!DOCTYPE spec SYSTEM "man.dtd">
3
4 <manpage name="masqmail.get" section="5" desc="masqmail get configuration file">
5
6 <description> <p>This man page describes the options available for the
7 masqmail get configuration.</p>
8
9 </description>
10
11 <options>
12
13 <option>
14 <p><opt>protocol</opt> = <arg>string</arg></p>
15 <optdesc>
16 <p>The protocol with which you retrieve your mail. Currently only
17 'pop3' and 'apop' are supported. There is no default.</p>
18 </optdesc>
19 </option>
20
21 <option>
22 <p><opt>server</opt> = <arg>string</arg></p>
23 <optdesc>
24 <p>The server you get your mail from.</p>
25 </optdesc>
26 </option>
27
28 <option>
29 <p><opt>resolve_list</opt> = <arg>list</arg></p>
30 <optdesc>
31 <p>Specify the method how the domain of the server is resolved. Possible values are
32 dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX
33 pointer to a list of host names, these will be tried each in order
34 (lowest preference value first, equal preference values in random
35 order). For 'dns_a', the domain is assumed to be an A pointer. For
36 'byname', the library function <manref name="gethostbyname" section="3"/> will be used.</p>
37 <p>The default is "dns_a;byname". It does not make much sense here to use 'dns_mx'.</p>
38 </optdesc>
39 </option>
40
41 <option>
42 <p><opt>user</opt> = <arg>string</arg></p>
43 <optdesc>
44 <p>Your login name.</p>
45 </optdesc>
46 </option>
47
48 <option>
49 <p><opt>pass</opt> = <arg>string</arg></p>
50 <optdesc>
51 <p>Your password.</p>
52 </optdesc>
53 </option>
54
55 <option>
56 <p><opt>address</opt> = <arg>address</arg></p>
57 <optdesc>
58 <p>The address where the retrieved mail should be sent to. It can be
59 any address, but you probably want to set this to a local address on
60 your LAN.</p>
61 </optdesc>
62 </option>
63
64 <option>
65 <p><opt>return_path</opt> = <arg>address</arg></p>
66 <optdesc>
67 <p>If set, masqmail sets the return path to this address. Bounces
68 generated during further delivery will be sent to this address. If
69 unset, masqmail looks for the Return-Path: header in the mail, if
70 this does not exist it uses the From: address and if this fails,
71 postmaster will be used.
72 </p><p>
73 It is in most cases not useful to set this to the same address as
74 the 'address' option as this may generate multiple bounces.
75 postmaster is recommended.</p>
76 </optdesc>
77 </option>
78
79 <option>
80 <p><opt>do_keep</opt> = <arg>boolean</arg></p>
81 <optdesc>
82 <p>If you want to keep your mail on the server after you retrieved it,
83 set this to true. It is recommended that you also set <b>do_uidl</b>,
84 otherwise you will get the mail again each time you connect to the
85 server. Masqmail does not check any headers before it retrieves mail,
86 which may mark it as already fetched. Note that this behaviour is
87 different to that of fetchmail. The default is false.</p>
88 </optdesc>
89 </option>
90
91 <option>
92 <p><opt>do_uidl</opt> = <arg>boolean</arg></p>
93 <optdesc>
94 <p>If set, MasqMail keeps a list of unique IDs of mails already
95 fetched, so that they will not be retrieved again. Default is false.</p>
96 </optdesc>
97 </option>
98
99 <option>
100 <p><opt>do_uidl_dele</opt> = <arg>boolean</arg></p>
101 <optdesc>
102 <p>If set, and <opt>do_uidl</opt> is also set, MasqMail sends a delete (DELE)
103 command to the server for each message uid in the uid listing at the
104 beginning of the session. This prevents mail to be left on the server if
105 masqmail gets interrupted during a session before it can send the QUIT
106 command to the server. Default is false.
107 </p>
108 </optdesc>
109 </option>
110
111 <option>
112 <p><opt>max_size</opt> = <arg>numeric</arg></p>
113 <optdesc>
114 <p>If set to a value > 0, only messages smaller than this in bytes will be
115 retrieved. The default is 0.</p>
116 </optdesc>
117 </option>
118
119 <option>
120 <p><opt>max_count</opt> = <arg>numeric</arg></p>
121 <optdesc>
122 <p>If set to a value > 0, only <opt>max_count</opt> messages will be retrieved.
123 The default is 0.</p>
124 </optdesc>
125 </option>
126
127 <option>
128 <p><opt>wrapper</opt> = <arg>command</arg></p>
129 <optdesc>
130 <p>If set, instead of opening a connection to a remote server, <arg>command</arg> will
131 be called and all traffic will be piped to its
132 stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.</p>
133 <p>Example for ssl tunneling:</p>
134 <p>wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"</p>
135 </optdesc>
136 </option>
137
138 </options>
139
140 <section name = "Author">
141 <p>masqmail was written by Oliver Kurth
142 &lt;oku@masqmail.cx&gt;</p><p>You will find the newest version of
143 masqmail at <url href="http://masqmail.cx/masqmail/"/> or search for it
144 in freshmeat (<url href="http://www.freshmeat.net"/>). There is also a mailing list,
145 you will find information about it at masqmails main site.</p>
146 </section>
147
148 <section name = "Bugs">
149 <p>You should report them to the mailing list.</p>
150 </section>
151
152 <section name = "See also">
153 <p>
154 <manref name="masqmail" section="8" href="masqmail.8.html"/>, <manref name="masqmail.route" section="5" href="masqmail.route.5.html"/>, <manref name="masqmail.conf" section="5" href="masqmail.conf.5.html"/>
155 </p>
156 </section>
157
158 <section name = "Comments">
159 <p>This man page was written using <manref name="xml2man" section="1"
160 href="http://masqmail.cx/xml2man/"/> by the same
161 author.</p>
162 </section>
163
164 </manpage>
165