masqmail

view docs/old-manual/docs/masqmail.get.5.html @ 60:e119cee8d493

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