masqmail
view man/masqmail.route.5 @ 390:68ae9182059c
Refactoring and code layouting.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Sat, 18 Feb 2012 13:50:02 +0100 |
| parents | 08932c629849 |
| children | 5593964ec779 |
line source
1 .TH masqmail.route 5 2012-01-18 masqmail-0.3.4 "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 You probably want to set this to true for permanent routes.
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
129 (lowest preference value first, equal preference values in random order).
130 For `dns_a', the domain is assumed to be an A pointer.
131 For `byname', the library function \fBgethostbyname(3)\fR will be used.
133 For routes to a local network, where you likely don't have a DNS service,
134 use only `byname'.
136 The default is "dns_mx;dns_a;byname".
138 .TP
139 \fBhelo_name\fR = \fIstring\fR
141 Set the name given with the HELO/EHLO command. If this is not set,
142 \fBhost_name\fR from \fImasqmail.conf\fR will be used,
143 if the \fBdo_correct_helo\fR option (see below) is unset.
145 .TP
146 \fBdo_correct_helo\fR = \fIboolean\fR
148 If this is set, masqmail tries to look up your host name as it appears
149 on the internet and sends this in the HELO/EHLO command.
150 Some servers are so picky that they want this.
151 Which is really crazy.
152 It just does not make any sense to lie about ones own identity,
153 because it can always be looked up by the server.
154 Nobody should believe in the name given by HELO/EHLO anyway.
155 If this is not set, \fBhost_name\fR from \fImasqmail.conf\fR or as given with
156 the \fBhelo_name\fR (see above) will be used.
158 .TP
159 \fBinstant_helo\fR = \fIboolean\fR
161 If this is set, masqmail does not wait for the greeting of the SMTP server
162 after opening the connection.
163 Instead it says EHLO right away (ESMTP is assumed).
164 Use this option with wrappers that eat the 220 greeting of the SMTP server.
165 Common examples are STARTTLS wrappers, like `openssl s_client \-starttls smtp ...'.
167 If this option is set and a 220 greeting is received though,
168 everything should still work.
169 Please don't rely on that and keep in mind that RFC 2821 says that the client
170 SHOULD wait for the 220 greeting of the server.
172 Default: false
174 .TP
175 \fBdo_pipelining\fR = \fIboolean\fR
177 If this is set to false, masqmail will not use ESMTP PIPELINING,
178 even if the server announces that it is able to cope with it.
179 Default is true.
181 You do not want to set this to false unless the mail setup on the
182 remote server side is really broken.
183 Keywords: wingate.
186 .TP
187 \fBauth_name\fR = \fIstring\fR
189 Set the authentication type for ESMTP AUTH authentication.
190 Currently only `cram-md5' and `login' are supported.
192 .TP
193 \fBauth_login\fR = \fIstring\fR
195 Your account name for ESMTP AUTH authentication.
197 .TP
198 \fBauth_secret\fR = \fIstring\fR
200 Your secret for ESMTP AUTH authentication.
202 .TP
203 \fBwrapper\fR = \fIcommand\fR
205 If set, instead of opening a connection to a remote server,
206 \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
207 Purpose is to tunnel ip traffic, eg. for ssl.
209 Example for SMTP over SSL tunneling:
210 .nf
211 wrapper="/usr/bin/openssl s_client \-quiet \-connect mail.gmx.net:465 2>/dev/null"
212 .fi
214 SMTP over SSL is supported since masqmail-0.1.8.
215 It is marked obsolete by the IETF but is still in use.
218 Example for encryption with STARTTLS (RFC-3207):
219 .nf
220 # don't forget the instant_helo, otherwise it won't work
221 instant_helo=true
222 wrapper="/usr/bin/openssl s_client \-quiet \-starttls smtp \-connect mail.gmx.net:25 2>/dev/null"
223 .fi
225 This is supported since masqmail-0.2.28.
226 STARTTLS supersedes SMTP over SSL.
228 Note for openssl:
229 Ensure that stderr is redirected.
230 Do *not* use \-crlf in the wrapper command, because masqmail does already insert CRLF.
231 However, you might want to specify \-crlf if you want to test your wrapper command
232 interactively on the command line.
235 .SH PIPE CONFIGURATION
237 .TP
238 \fBpipe\fR = \fIcommand\fR
240 \fIcommand\fR will be called and the message will be piped to its stdin.
241 Purpose is to use gateways to uucp, fax, sms or whatever else.
243 You can use variables to give as arguments to the command,
244 these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR.
246 .TP
247 \fBpipe_fromline = \fIboolean\fR
249 Only if `pipe' is used.
250 A from line will be prepended to the output stream whenever a pipe command is called.
251 Default is false.
253 .TP
254 \fBpipe_fromhack = \fIboolean\fR
256 Only if `pipe' is used.
257 Each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called.
258 You probably want this if you have set \fBpipe_fromline\fR above.
259 Default is false.
262 .SH ADDRESS REWRITE RULES
264 .TP
265 \fBset_h_from_domain\fR = \fIstring\fR
267 Replace the domain part in `From:' headers with this value.
268 This may be useful if you use a private, outside unknown address on your local LAN
269 and want this to be replaced by the domain of the address of your email address on the internet.
270 Note that this is different to \fBset_return_path_domain\fR, see below.
272 .TP
273 \fBset_h_reply_to_domain\fR = \fIstring\fR
275 Same as \fBset_h_from_domain\fP, but for the `Reply-To' header.
277 .TP
278 \fBset_return_path_domain\fR = \fIstring\fR
280 Sets the domain part of the envelope from address.
281 Some hosts check whether this is the same as the net the connection is coming from.
282 If not, they reject the mail because they suspect spamming.
283 It should be a valid address, because some mail servers also check that.
284 You can also use this to set it to your usual address on the internet
285 and put a local address only known on your LAN in the configuration of your mailer.
286 Only the domain part will be changed, the local part remains unchanged.
287 Use \fBmap_return_path_addresses\fR for rewriting local parts.
289 .TP
290 \fBmap_h_from_addresses\fR = \fIlist\fR
292 This is similar to \fBset_h_from_domain\fR, but more flexible.
293 Set this to a list which maps local parts to a full RFC 822 compliant email address,
294 the local parts (the keys) are separated from the addresses (the values) by colons (`:').
296 Example:
297 .nf
298 map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; charlie: Charlie Miller <cmiller@mx.commercial.com>"
299 .fi
301 You can use patterns, eg. * as keys.
303 .TP
304 \fBmap_h_reply_to_addresses\fR = \fIlist\fR
306 Same as \fBmap_h_from_addresses\fR, but for the `Reply-To:' header.
308 .TP
309 \fBmap_h_mail_followup_to_addresses\fR = \fIlist\fR
311 Same as \fBmap_h_from_addresses\fR, but for the `Mail-Followup-To:' header.
312 Useful when replying to mailing lists.
314 .TP
315 \fBmap_return_path_addresses\fR = \fIlist\fR
317 This is similar to \fBset_return_path_domain\fR, but more flexible.
318 Set this to a list which maps local parts to a full RFC 821 compliant email address,
319 the local parts (the keys) are separated from the addresses (the values) by colons (`:').
320 Note that this option takes RFC 821 addresses while \fBmap_h_from_addresses\fR takes RFC 822 addresses.
321 The most important difference is that RFC 821 addresses have no full name.
323 Example:
324 .nf
325 map_return_path_addresses = "john: <jsmith@mail.academic.edu>; charlie: <cmiller@mx.commercial.com>"
326 .fi
328 You can use patterns, eg. * as keys.
330 .TP
331 \fBexpand_h_sender_address\fR = \fIboolean\fR
333 This sets the domain of the sender address as given by the Sender: header
334 to the same address as in the envelope return path address
335 (which can be set by either \fBset_return_path_domain\fR or \fBmap_return_path_addresses\fR).
336 This is for mail clients (eg. Microsoft Outlook) which use this address as the sender address.
337 Though they should use the From: address, see RFC 821.
338 If \fBfetchmail(1)\fR encounters an unqualified Sender: address,
339 it will be expanded to the domain of the pop server, which is almost never correct.
340 Default is true.
342 .TP
343 \fBexpand_h_sender_domain\fR = \fIboolean\fR
345 Like \fBexpand_h_sender_address\fR, but sets the domain only.
346 Deprecated, will be removed in a later version.
349 .SH AUTHOR
351 Masqmail was written by Oliver Kurth.
352 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
354 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
355 There is also a mailing list, you will find information about it at masqmail's main site.
358 .SH BUGS
360 Please report bugs to the mailing list.
362 .SH SEE ALSO
364 \fBmasqmail(8)\fR, \fBmasqmail.conf(5)\fR