masqmail
view man/masqmail.route.5 @ 332:63efd381e27b
refactoring, partly also related to set_euidgid()
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Sat, 27 Aug 2011 16:21:17 +0200 |
| parents | 290da1595311 |
| children | ef346dc67514 |
line source
1 .TH masqmail.route 5 2011-06-03 masqmail-0.3.2 "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 Mail will be sent with the SMTP protocol to its destination, unless
13 `pipe' is given.
14 In this case the message will be piped to the given program.
17 .SH ROUTE CONDITIONS
19 .TP
20 \fBallowed_senders\fR = \fIlist\fR
22 This is a semicolon `;' separated list of envelope sender addresses.
23 Messages which have one of these addresses as the return path (= mail
24 from) are allowed to use this route
25 (if not also in \fBdenied_senders\fR).
27 Glob patterns containing `?' and `*' can be used.
28 The special item "<>" matches the null sender address
29 (eg. failure notices or delivery notifications).
30 If the pattern doesn't contain an `@', it is seen as a pattern for the
31 local part only.
33 Example: \fImeillo;*@*example.org;web*@example.com\fP
35 (``meillo'' equals ``meillo@*'', i.e. the local part.)
37 .TP
38 \fBdenied_senders\fR = \fIlist\fR
40 This is a semicolon `;' separated list of envelope sender addresses.
41 Messages which have one of these addresses as the return path (=
42 mail from) will not
43 be sent using this route (even if also in \fBallowed_senders\fR).
45 Glob patterns containing `?' and `*' can be used.
46 The special item "<>" matches the null sender address
47 (eg. failure notices or delivery notifications).
48 If the pattern doesn't contain an `@', it is seen as a pattern for the
49 local part only.
51 Example: (see \fIallowed_senders\fP)
53 .TP
54 \fBallowed_recipients\fR = \fIlist\fR
56 A list of envelope recipient addresses where mail can be sent to using
57 this route.
58 This is for example useful if you use this route configuration when connected to another LAN via ppp.
59 Glob patterns containing `?' and `*' can be used.
61 Example: \fI*@example.org;*@*foo.bar\fP
63 (See also examples for \fIallowed_senders\fP)
65 .TP
66 \fBdenied_recipients\fR = \fIlist\fR
68 A list of envelope recipient addresses where mail will not be sent to
69 using this route.
70 This is for example useful if you send mail directly (\fBmail_host\fR is not set)
71 and you know of hosts that will not accept mail from you because they use a dialup list
72 (eg. \fBhttp://maps.vix.com/dul/\fR).
73 \fBdenied_recipients\fR overrules \fBallowed_recipients\fR.
74 Glob patterns containing `?' and `*' can be used.
76 Example: \fI*@spamblocker.example.org\fP
78 (See also examples for \fIallowed_senders\fP)
80 .TP
81 \fBlast_route\fR = \fIboolean\fR
83 If this is set, a mail which would have been delivered using this route,
84 but has failed temporarily, will not be tried to be delivered using the next route.
86 If you have set up a special route with filters using the lists
87 `allowed_recipients' and `allowed_senders' or their complements
88 (denied_),
89 and the mail passing these rules should be delivered using this route only,
90 you should set this to `true'.
91 Otherwise the mail would be passed to the next route (if any),
92 unless that route has rules which prevent that.
94 Default is false.
96 .TP
97 \fBconnect_error_fail\fR = \fIboolean\fR
99 If this is set, a connection error (or if a pipe command could not be
100 executed) will cause a mail delivery to fail, ie. it will be bounced.
101 If it is unset, it will just be defered.
103 Default is false.
104 The reason for this is that masqmail is designed for non permanent internet connections,
105 where such errors may occur quite often, and a bounce would be annoying.
107 For the default local_net route it is set to true.
110 .SH SMTP CONFIGURATION
112 .TP
113 \fBmail_host\fR = \fIstring\fR
115 This is preferably the mail server of your ISP.
116 All outgoing messages will be sent to this host which will distribute them to their destinations.
117 If you do not set this mails will be sent directly.
118 Because the mail server is probably `near' to you, mail transfer will be much faster if you use it.
120 You can optionally give a port number following the host name and a colon, eg mail_host="mail.foo.com:25".
122 .TP
123 \fBresolve_list\fR = \fIlist\fR
125 Specify the method how the domain of the server is resolved.
126 Possible values are dns_mx, dns_a, byname.
127 For `dns_mx', the domain is assumed to be an MX pointer to a list of host names,
128 these will be tried each in order (lowest preference value first, equal preference values in random order).
129 For `dns_a', the domain is assumed to be an A pointer.
130 For `byname', the library function \fBgethostbyname(3)\fR will be used.
132 The default is "dns_mx;dns_a;byname".
134 .TP
135 \fBhelo_name\fR = \fIstring\fR
137 Set the name given with the HELO/EHLO command. If this is not set,
138 \fBhost_name\fR from \fImasqmail.conf\fR will be used,
139 if the \fBdo_correct_helo\fR option (see below) is unset.
141 .TP
142 \fBdo_correct_helo\fR = \fIboolean\fR
144 If this is set, masqmail tries to look up your host name as it appears
145 on the internet and sends this in the HELO/EHLO command.
146 Some servers are so picky that they want this.
147 Which is really crazy.
148 It just does not make any sense to lie about ones own identity,
149 because it can always be looked up by the server.
150 Nobody should believe in the name given by HELO/EHLO anyway.
151 If this is not set, \fBhost_name\fR from \fImasqmail.conf\fR or as given with
152 the \fBhelo_name\fR (see above) will be used.
154 .TP
155 \fBinstant_helo\fR = \fIboolean\fR
157 If this is set, masqmail does not wait for the greeting of the SMTP server
158 after opening the connection.
159 Instead it says EHLO right away (ESMTP is assumed).
160 Use this option with wrappers that eat the 220 greeting of the SMTP server.
161 Common examples are STARTTLS wrappers, like `openssl s_client -starttls smtp ...'.
163 If this option is set and a 220 greeting is received though,
164 everything should still work.
165 Please don't rely on that and keep in mind that RFC 2821 says that the client
166 SHOULD wait for the 220 greeting of the server.
168 Default: false
170 .TP
171 \fBdo_pipelining\fR = \fIboolean\fR
173 If this is set to false, masqmail will not use ESMTP PIPELINING,
174 even if the server announces that it is able to cope with it.
175 Default is true.
177 You do not want to set this to false unless the mail setup on the
178 remote server side is really broken.
179 Keywords: wingate.
182 .TP
183 \fBauth_name\fR = \fIstring\fR
185 Set the authentication type for ESMTP AUTH authentication.
186 Currently only `cram-md5' and `login' are supported.
188 .TP
189 \fBauth_login\fR = \fIstring\fR
191 Your account name for ESMTP AUTH authentication.
193 .TP
194 \fBauth_secret\fR = \fIstring\fR
196 Your secret for ESMTP AUTH authentication.
198 .TP
199 \fBwrapper\fR = \fIcommand\fR
201 If set, instead of opening a connection to a remote server,
202 \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
203 Purpose is to tunnel ip traffic, eg. for ssl.
205 Example for SMTP over SSL tunneling:
206 .nf
207 wrapper="/usr/bin/openssl s_client \-quiet \-connect mail.gmx.net:465 2>/dev/null"
208 .fi
210 SMTP over SSL is supported since masqmail-0.1.8.
211 It is marked obsolete by the IETF but is still in use.
214 Example for encryption with STARTTLS (RFC-3207):
215 .nf
216 # don't forget the instant_helo, otherwise it won't work
217 instant_helo=true
218 wrapper="/usr/bin/openssl s_client \-quiet \-starttls smtp \-connect mail.gmx.net:25 2>/dev/null"
219 .fi
221 This is supported since masqmail-0.2.28.
222 STARTTLS supersedes SMTP over SSL.
224 Note for openssl:
225 Ensure that stderr is redirected.
226 Do *not* use \-crlf in the wrapper command, because masqmail does already insert CRLF.
227 However, you might want to specify \-crlf if you want to test your wrapper command
228 interactively on the command line.
231 .SH PIPE CONFIGURATION
233 .TP
234 \fBpipe\fR = \fIcommand\fR
236 \fIcommand\fR will be called and the message will be piped to its stdin.
237 Purpose is to use gateways to uucp, fax, sms or whatever else.
239 You can use variables to give as arguments to the command,
240 these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR.
242 .TP
243 \fBpipe_fromline = \fIboolean\fR
245 Only if `pipe' is used.
246 A from line will be prepended to the output stream whenever a pipe command is called.
247 Default is false.
249 .TP
250 \fBpipe_fromhack = \fIboolean\fR
252 Only if `pipe' is used.
253 Each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called.
254 You probably want this if you have set \fBpipe_fromline\fR above.
255 Default is false.
258 .SH ADDRESS REWRITE RULES
260 .TP
261 \fBset_h_from_domain\fR = \fIstring\fR
263 Replace the domain part in `From:' headers with this value.
264 This may be useful if you use a private, outside unknown address on your local LAN
265 and want this to be replaced by the domain of the address of your email address on the internet.
266 Note that this is different to \fBset_return_path_domain\fR, see below.
268 .TP
269 \fBset_h_reply_to_domain\fR = \fIstring\fR
271 Same as \fBset_h_from_domain\fP, but for the `Reply-To' header.
273 .TP
274 \fBset_return_path_domain\fR = \fIstring\fR
276 Sets the domain part of the envelope from address.
277 Some hosts check whether this is the same as the net the connection is coming from.
278 If not, they reject the mail because they suspect spamming.
279 It should be a valid address, because some mail servers also check that.
280 You can also use this to set it to your usual address on the internet
281 and put a local address only known on your LAN in the configuration of your mailer.
282 Only the domain part will be changed, the local part remains unchanged.
283 Use \fBmap_return_path_addresses\fR for rewriting local parts.
285 .TP
286 \fBmap_h_from_addresses\fR = \fIlist\fR
288 This is similar to \fBset_h_from_domain\fR, but more flexible.
289 Set this to a list which maps local parts to a full RFC 822 compliant email address,
290 the local parts (the keys) are separated from the addresses (the values) by colons (`:').
292 Example:
293 .nf
294 map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; charlie: Charlie Miller <cmiller@mx.commercial.com>"
295 .fi
297 You can use patterns, eg. * as keys.
299 .TP
300 \fBmap_h_reply_to_addresses\fR = \fIlist\fR
302 Same as \fBmap_h_from_addresses\fR, but for the `Reply-To:' header.
304 .TP
305 \fBmap_h_mail_followup_to_addresses\fR = \fIlist\fR
307 Same as \fBmap_h_from_addresses\fR, but for the `Mail-Followup-To:' header.
308 Useful when replying to mailing lists.
310 .TP
311 \fBmap_return_path_addresses\fR = \fIlist\fR
313 This is similar to \fBset_return_path_domain\fR, but more flexible.
314 Set this to a list which maps local parts to a full RFC 821 compliant email address,
315 the local parts (the keys) are separated from the addresses (the values) by colons (`:').
316 Note that this option takes RFC 821 addresses while \fBmap_h_from_addresses\fR takes RFC 822 addresses.
317 The most important difference is that RFC 821 addresses have no full name.
319 Example:
320 .nf
321 map_return_path_addresses = "john: <jsmith@mail.academic.edu>; charlie: <cmiller@mx.commercial.com>"
322 .fi
324 You can use patterns, eg. * as keys.
326 .TP
327 \fBexpand_h_sender_address\fR = \fIboolean\fR
329 This sets the domain of the sender address as given by the Sender: header
330 to the same address as in the envelope return path address
331 (which can be set by either \fBset_return_path_domain\fR or \fBmap_return_path_addresses\fR).
332 This is for mail clients (eg. Microsoft Outlook) which use this address as the sender address.
333 Though they should use the From: address, see RFC 821.
334 If \fBfetchmail(1)\fR encounters an unqualified Sender: address,
335 it will be expanded to the domain of the pop server, which is almost never correct.
336 Default is true.
338 .TP
339 \fBexpand_h_sender_domain\fR = \fIboolean\fR
341 Like \fBexpand_h_sender_address\fR, but sets the domain only.
342 Deprecated, will be removed in a later version.
345 .SH AUTHOR
347 Masqmail was written by Oliver Kurth.
348 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
350 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
351 There is also a mailing list, you will find information about it at masqmail's main site.
354 .SH BUGS
356 Please report bugs to the mailing list.
358 .SH SEE ALSO
360 \fBmasqmail(8)\fR, \fBmasqmail.conf(5)\fR