masqmail
view man/masqmail.route.5 @ 227:cab46cefa4ce
renamed contrib/ to admin/
because the contents are for system admins
and possibly for advanced users too
| author | meillo@marmaro.de |
|---|---|
| date | Fri, 23 Jul 2010 11:49:44 +0200 |
| parents | 8cddc65765bd |
| children | 9397d10fd771 |
line source
1 .TH masqmail.route 5 2010-07-06 masqmail-0.2.25 "File Formats"
3 .SH NAME
4 masqmail.route \- masqmail route configuration file
7 .SH DESCRIPTION
9 This man page describes the syntax of the route configuration files of \fBmasqmail (8)\fR.
10 Their usual locations are in \fI/etc/masqmail/\fR.
12 .SH OPTIONS
14 .TP
15 \fBprotocol\fR = \fIstring\fR
17 \fIstring\fR can be one of `smtp' or `pipe', default is `smtp'.
18 If set to `smtp', mail will be sent with the SMTP protocol to its destination.
19 If set to `pipe', you also have to set `pipe' to a command, the message will then be piped to a program.
20 See option `pipe' below.
22 .TP
23 \fBmail_host\fR = \fIstring\fR
25 This is preferably the mail server of your ISP.
26 All outgoing messages will be sent to this host which will distribute them to their destinations.
27 If you do not set this mails will be sent directly.
28 Because the mail server is probably `near' to you, mail transfer will be much faster if you use it.
30 You can optionally give a port number following the host name and a colon, eg mail_host="mail.foo.com:25".
32 .TP
33 \fBresolve_list\fR = \fIlist\fR
35 Specify the method how the domain of the server is resolved.
36 Possible values are dns_mx, dns_a, byname.
37 For `dns_mx', the domain is assumed to be an MX pointer to a list of host names,
38 these will be tried each in order (lowest preference value first, equal preference values in random order).
39 For `dns_a', the domain is assumed to be an A pointer.
40 For `byname', the library function \fBgethostbyname(3)\fR will be used.
42 The default is "dns_mx;dns_a;byname".
44 .TP
45 \fBconnect_error_fail\fR = \fIboolean\fR
47 If this is set, a connection error will cause a mail delivery to fail, ie. it will be bounced.
48 If it is unset, it will just be defered.
50 Default is false.
51 The reason for this is that masqmail is designed for non permanent internet connections,
52 where such errors may occur quite often, and a bounce would be annoying.
54 For the default local_net route it is set to true.
56 .TP
57 \fBhelo_name\fR = \fIstring\fR
59 Set the name given with the HELO/EHLO command. If this is not set,
60 \fBhost_name\fR from \fImasqmail.conf\fR will be used,
61 if the \fBdo_correct_helo\fR option (see below) is unset.
63 .TP
64 \fBdo_correct_helo\fR = \fIboolean\fR
66 If this is set, masqmail tries to look up your host name as it appears
67 on the internet and sends this in the HELO/EHLO command.
68 Some servers are so picky that they want this.
69 Which is really crazy.
70 It just does not make any sense to lie about ones own identity,
71 because it can always be looked up by the server.
72 Nobody should believe in the name given by HELO/EHLO anyway.
73 If this is not set, \fBhost_name\fR from \fImasqmail.conf\fR or as given with
74 the \fBhelo_name\fR (see above) will be used.
76 .TP
77 \fBinstant_helo\fR = \fIboolean\fR
79 If this is set, masqmail does not wait for the greeting of the SMTP server
80 after opening the connection.
81 Instead it says EHLO right away (ESMTP is assumed).
82 Use this option with wrappers that eat the 220 greeting of the SMTP server.
83 Common examples are STARTTLS wrappers, like `openssl s_client -starttls smtp ...'.
85 If this option is set and a 220 greeting is received though,
86 everything should still work.
87 Please don't rely on that and keep in mind that RFC 2821 says that the client
88 SHOULD wait for the 220 greeting of the server.
90 Default: false
93 .TP
94 \fBdo_pipelining\fR = \fIboolean\fR
96 If this is set to false, masqmail will not use ESMTP PIPELINING,
97 even if the server announces that it is able to cope with it.
98 Default is true.
100 You do not want to set this to false unless the mail setup on the
101 remote server side is really broken.
102 Keywords: wingate.
104 .TP
105 \fBallowed_mail_locals\fR = \fIlist\fR
107 This is a semicolon `;' separated list of local parts which will be allowed
108 to send mail through this connection.
109 If unset and \fBnot_allowed_mail_locals\fR is also unset, all users are allowed.
111 .TP
112 \fBnot_allowed_mail_locals\fR = \fIlist\fR
114 This is a semicolon `;' separated list of local parts which will be not allowed
115 to send mail through this connection.
116 Local parts in this list will not be allowed to use this route even if they
117 are part of \fBallowed_mail_locals\fR (see above).
119 .TP
120 \fBallowed_return_paths\fR = \fIlist\fR
122 This is a semicolon `;' separated list of addresses.
123 Messages which have one of these addresses as the return path will be used using this route
124 (if not also in \fBnot_allowed_return_paths\fR or an item in \fBnot_allowed_mail_locals\fR matches).
126 Patterns containing `?' and `*' can be used.
127 The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
129 .TP
130 \fBnot_allowed_return_paths\fR = \fIlist\fR
132 This is a semicolon `;' separated list of addresses.
133 Messages which have one of these addresses as the return path will not
134 be used using this route (even if also in \fBallowed_return_paths\fR
135 or an item in \fBallowed_mail_locals\fR matches).
137 Patterns containing `?' and `*' can be used.
138 The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
140 .TP
141 \fBallowed_rcpt_domains\fR = \fIlist\fR
143 A list of recipient domains where mail will be sent to.
144 This is for example useful if you use this route configuration when connected to another LAN via ppp.
145 Patterns containing `?' and `*' can be used.
147 .TP
148 \fBnot_allowed_rcpt_domains\fR = \fIlist\fR
150 A list of recipient domains where mail will not be sent to.
151 This is for example useful if you send mail directly (\fBmail_host\fR is not set)
152 and you know of hosts that will not accept mail from you because they use a dialup list
153 (eg. \fBhttp://maps.vix.com/dul/\fR).
154 If any domain matches both \fBallowed_rcpt_domains\fR and \fBnot_allowed_rcpt_domains\fR,
155 mail will not be sent to this domain.
156 Patterns containing `?' and `*' can be used.
158 .TP
159 \fBset_h_from_domain\fR = \fIstring\fR
161 Replace the domain part in `From:' headers with this value.
162 This may be useful if you use a private, outside unknown address on your local LAN
163 and want this to be replaced by the domain of the address of your email address on the internet.
164 Note that this is different to \fBset_return_path_domain\fR, see below.
166 .TP
167 \fBset_h_reply_to_domain\fR = \fIstring\fR
169 Same as \fBset_h_from_domain\fP, but for the `Reply-To' header.
171 .TP
172 \fBset_return_path_domain\fR = \fIstring\fR
174 Sets the domain part of the envelope from address.
175 Some hosts check whether this is the same as the net the connection is coming from.
176 If not, they reject the mail because they suspect spamming.
177 It should be a valid address, because some mail servers also check that.
178 You can also use this to set it to your usual address on the internet
179 and put a local address only known on your LAN in the configuration of your mailer.
180 Only the domain part will be changed, the local part remains unchanged.
181 Use \fBmap_return_path_addresses\fR for rewriting local parts.
183 .TP
184 \fBmap_h_from_addresses\fR = \fIlist\fR
186 This is similar to \fBset_h_from_domain\fR, but more flexible.
187 Set this to a list which maps local parts to a full RFC 822 compliant email address,
188 the local parts (the keys) are separated from the addresses (the values) by colons (`:').
190 Example:
191 .nf
192 map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; charlie: Charlie Miller <cmiller@mx.commercial.com>"
193 .fi
195 You can use patterns, eg. * as keys.
197 .TP
198 \fBmap_h_reply_to_addresses\fR = \fIlist\fR
200 Same as \fBmap_h_from_addresses\fR, but for the `Reply-To:' header.
202 .TP
203 \fBmap_h_mail_followup_to_addresses\fR = \fIlist\fR
205 Same as \fBmap_h_from_addresses\fR, but for the `Mail-Followup-To:' header.
206 Useful when replying to mailing lists.
208 .TP
209 \fBmap_return_path_addresses\fR = \fIlist\fR
211 This is similar to \fBset_return_path_domain\fR, but more flexible.
212 Set this to a list which maps local parts to a full RFC 821 compliant email address,
213 the local parts (the keys) are separated from the addresses (the values) by colons (`:').
214 Note that this option takes RFC 821 addresses while \fBmap_h_from_addresses\fR takes RFC 822 addresses.
215 The most important difference is that RFC 821 addresses have no full name.
217 Example:
218 .nf
219 map_return_path_addresses = "john: <jsmith@mail.academic.edu>; charlie: <cmiller@mx.commercial.com>"
220 .fi
222 You can use patterns, eg. * as keys.
224 .TP
225 \fBexpand_h_sender_address\fR = \fIboolean\fR
227 This sets the domain of the sender address as given by the Sender: header
228 to the same address as in the envelope return path address
229 (which can be set by either \fBset_return_path_domain\fR or \fBmap_return_path_addresses\fR).
230 This is for mail clients (eg. Microsoft Outlook) which use this address as the sender address.
231 Though they should use the From: address, see RFC 821.
232 If \fBfetchmail(1)\fR encounters an unqualified Sender: address,
233 it will be expanded to the domain of the pop server, which is almost never correct.
234 Default is true.
236 .TP
237 \fBexpand_h_sender_domain\fR = \fIboolean\fR
239 Like \fBexpand_h_sender_address\fR, but sets the domain only.
240 Deprecated, will be removed in a later version.
242 .TP
243 \fBlast_route\fR = \fIboolean\fR
245 If this is set, a mail which would have been delivered using this route,
246 but has failed temporarily, will not be tried to be delivered using the next route.
248 If you have set up a special route with filters using the lists `allowed_rcpt_domains',
249 `allowed_return_paths', and `allowed_mail_locals' or their complements (not_),
250 and the mail passing these rules should be delivered using this route only,
251 you should set this to `true'.
252 Otherwise the mail would be passed to the next route (if any),
253 unless that route has rules which prevent that.
255 Default is false.
257 .TP
258 \fBauth_name\fR = \fIstring\fR
260 Set the authentication type for ESMTP AUTH authentication.
261 Currently only `cram-md5' and `login' are supported.
263 .TP
264 \fBauth_login\fR = \fIstring\fR
266 Your account name for ESMTP AUTH authentication.
268 .TP
269 \fBauth_secret\fR = \fIstring\fR
271 Your secret for ESMTP AUTH authentication.
273 .TP
274 \fBwrapper\fR = \fIcommand\fR
276 If set, instead of opening a connection to a remote server,
277 \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
278 Purpose is to tunnel ip traffic, eg. for ssl.
280 Example for SMTP over SSL tunneling:
281 .nf
282 wrapper="/usr/bin/openssl s_client \-quiet \-connect mail.gmx.net:465 2>/dev/null"
283 .fi
285 SMTP over SSL is supported since masqmail-0.1.8.
286 It is marked obsolete by the IETF but is still in use.
289 Example for encryption with STARTTLS (RFC-3207):
290 .nf
291 # don't forget the instant_helo, otherwise it won't work
292 instant_helo=true
293 wrapper="/usr/bin/openssl s_client \-quiet \-starttls smtp \-connect mail.gmx.net:25 2>/dev/null"
294 .fi
296 This is supported since masqmail-0.2.28.
297 STARTTLS supersedes SMTP over SSL.
299 Note for openssl:
300 Ensure that stderr is redirected.
301 Do *not* use \-crlf in the wrapper command, because masqmail does already insert CRLF.
302 However, you might want to specify \-crlf if you want to test your wrapper command
303 interactively on the command line.
305 .TP
306 \fBpipe\fR = \fIcommand\fR
308 If set, and protocol is set to `pipe',
309 \fIcommand\fR will be called and the message will be piped to its stdin.
310 Purpose is to use gateways to uucp, fax, sms or whatever else.
312 You can use variables to give as arguments to the command,
313 these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR.
315 .TP
316 \fBpipe_fromline = \fIboolean\fR
318 If this is set, and protocol is set to `pipe',
319 a from line will be prepended to the output stream whenever a pipe command is called.
320 Default is false.
322 .TP
323 \fBpipe_fromhack = \fIboolean\fR
325 If this is set, and protocol is set to `pipe',
326 each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called.
327 You probably want this if you have set \fBpipe_fromline\fR above.
328 Default is false.
331 .SH AUTHOR
333 Masqmail was written by Oliver Kurth.
334 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
336 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
337 There is also a mailing list, you will find information about it at masqmail's main site.
340 .SH BUGS
342 Please report bugs to the mailing list.
344 .SH SEE ALSO
346 \fBmasqmail(8)\fR, \fBmasqmail.conf(5)\fR