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