masqmail-0.2

view man/masqmail.get.5 @ 139:4d32eb75d3bc

find changesets by author, revision, files, or words in the commit message
/^\\fB/ in man pages indicates an option this allows automated testing if all config options are documented seems like this is just a hack, but it works ... so what?
author meillo@marmaro.de
date Tue, 06 Jul 2010 17:37:18 +0200
parents e01fed4846e4
children 0e7601b8cebf
line source
1 .TH masqmail.get 5 2010-07-06 masqmail-0.2.25 "File Formats"
2
3 .SH NAME
4 masqmail.get \- masqmail get configuration file
5
6
7 .SH DESCRIPTION
8
9 This man page describes the options available for the masqmail get configuration.
10
11
12 .SH OPTIONS
13
14 .TP
15 \fBprotocol\fR = \fIstring\fR
16
17 The protocol with which you retrieve your mail.
18 Currently only `pop3' and `apop' are supported.
19 There is no default.
20
21 .TP
22 \fBserver\fR = \fIstring\fR
23
24 The server you get your mail from.
25
26 .TP
27 \fBport\fR = \fInumber\fR
28
29 The port number of \fBserver\fP to connect to.
30
31 Default: 110.
32
33 .TP
34 \fBresolve_list\fR = \fIlist\fR
35
36 Specify the method how the domain of the server is resolved.
37 Possible values are dns_mx, dns_a, byname.
38 For `dns_mx', the domain is assumed to be an MX pointer to a list of host names,
39 these will be tried each in order
40 (lowest preference value first, equal preference values in random order).
41 For `dns_a', the domain is assumed to be an A pointer.
42 For `byname', the library function \fBgethostbyname(3)\fR will be used.
43
44 The default is "dns_a;byname".
45 It does not make much sense here to use `dns_mx'.
46
47 .TP
48 \fBuser\fR = \fIstring\fR
49
50 Your login name.
51
52 .TP
53 \fBpass\fR = \fIstring\fR
54
55 Your password.
56
57 .TP
58 \fBaddress\fR = \fIaddress\fR
59
60 The address where the retrieved mail should be sent to.
61 It can be any address, but you probably want to set this to a local address on your LAN.
62
63 .TP
64 \fBreturn_path\fR = \fIaddress\fR
65
66 If set, masqmail sets the return path to this address.
67 Bounces generated during further delivery will be sent to this address.
68 If unset, masqmail looks for the Return-Path: header in the mail,
69 if this does not exist it uses the From: address and if this fails, postmaster will be used.
70
71 It is in most cases not useful to set this to the same address as the `address'
72 option as this may generate multiple bounces.
73 postmaster is recommended.
74
75 .TP
76 \fBdo_keep\fR = \fIboolean\fR
77
78 If you want to keep your mail on the server after you retrieved it, set this to true.
79 It is recommended that you also set do_uidl,
80 otherwise you will get the mail again each time you connect to the server.
81 Masqmail does not check any headers before it retrieves mail, which may mark it as already fetched.
82 Note that this behaviour is different to that of fetchmail.
83 The default is false.
84
85 .TP
86 \fBdo_uidl\fR = \fIboolean\fR
87
88 If set, masqmail keeps a list of unique IDs of mails already fetched,
89 so that they will not be retrieved again.
90 Default is false.
91
92 .TP
93 \fBdo_uidl_dele\fR = \fIboolean\fR
94
95 If set, and \fBdo_uidl\fR is also set, MasqMail sends a delete (DELE) command
96 to the server for each message uid in the uid listing at the beginning of the session.
97 This prevents mail to be left on the server if masqmail gets interrupted during
98 a session before it can send the QUIT command to the server.
99 Default is false.
100
101 .TP
102 \fBmax_size\fR = \fInumeric\fR
103
104 If set to a value > 0, only messages smaller than this in bytes will be retrieved.
105 The default is 0.
106
107 .TP
108 \fBmax_count\fR = \fInumeric\fR
109
110 If set to a value > 0, only \fBmax_count\fR messages will be retrieved.
111 The default is 0.
112
113 .TP
114 \fBmax_size_delete\fR = \fIboolean\fR
115
116 If \fBmax_size\fP > 0 and \fBdo_uidl_dele\fP is set,
117 delete messages that are larger than \fImax_size\fP on the server
118 WITHOUT retrieving them.
119 Be careful with this option.
120
121 Default: false
122
123 .TP
124 \fBwrapper\fR = \fIcommand\fR
125
126 If set, instead of opening a connection to a remote server,
127 \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
128 Purpose is to tunnel ip traffic, e.g. for ssl.
129
130 Example for ssl tunneling:
131
132 wrapper="/usr/bin/openssl s_client \-quiet \-connect pop.gmx.net:995 2>/dev/null"
133
134
135 .SH AUTHOR
136
137 Masqmail was written by Oliver Kurth.
138 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
139
140 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
141 There is also a mailing list, you will find information about it at masqmail's main site.
142
143
144 .SH BUGS
145
146 Please report bugs to the mailing list.
147
148
149 .SH SEE ALSO
150
151 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.conf(5)\fR