masqmail-0.2
view docs/masqmail.route.5 @ 40:8071dc6c6ed1
next version will be 0.3.0
| author | meillo@marmaro.de |
|---|---|
| date | Mon, 10 May 2010 11:03:26 +0200 |
| parents | 8ea86ac25658 |
| children | 03817f849106 |
line source
1 .TH masqmail.route 5 2010-05-07 masqmail-0.3.0 "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 is 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 \fBdo_pipelining\fR = \fIboolean\fR
79 If this is set to false, masqmail will not use ESMTP PIPELINING,
80 even if the server announces that it is able to cope with it.
81 Default is true.
83 You do not want to set this to false unless the mail setup on the
84 remote server side is really broken.
85 Keywords: wingate.
87 .TP
88 \fBallowed_mail_locals\fR = \fIlist\fR
90 This is a semicolon `;' separated list of local parts which will be allowed
91 to send mail through this connection.
92 If unset and \fBnot_allowed_mail_locals\fR is also unset, all users are allowed.
94 .TP
95 \fBnot_allowed_mail_locals\fR = \fIlist\fR
97 This is a semicolon `;' separated list of local parts which will be not allowed
98 to send mail through this connection.
99 Local parts in this list will not be allowed to use this route even if they
100 are part of \fBallowed_mail_locals\fR (see above).
102 .TP
103 \fBallowed_return_paths\fR = \fIlist\fR
105 This is a semicolon `;' separated list of addresses.
106 Messages which have one one of these addresses as the return path will be used using this route
107 (if not also in \fBnot_allowed_return_paths\fR or an item in \fBnot_allowed_mail_locals\fR matches).
109 Patterns containing `?' and `*' can be used.
110 The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
112 .TP
113 \fBnot_allowed_return_paths\fR = \fIlist\fR
115 This is a semicolon `;' separated list of addresses.
116 Messages which have one one of these addresses as the return path will not
117 be used using this route (even if also in \fBallowed_return_paths\fR
118 or an item in \fBallowed_mail_locals\fR matches).
120 Patterns containing `?' and `*' can be used.
121 The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
123 .TP
124 \fBallowed_rcpt_domains\fR = \fIlist\fR
126 A list of recipient domains where mail will be sent to.
127 This is for example useful if you use this route configuration when connected to another LAN via ppp.
128 Patterns containing `?' and `*' can be used.
130 .TP
131 \fBnot_allowed_rcpt_domains\fR = \fIlist\fR
133 A list of recipient domains where mail will not be sent to.
134 This is for example useful if you send mail directly (\fBmail_host\fR is not set)
135 and you know of hosts that will not accept mail from you because they use a dialup list
136 (eg. \fBhttp://maps.vix.com/dul/\fR).
137 If any domain matches both \fBallowed_rcpt_domains\fR and \fBnot_allowed_rcpt_domains\fR,
138 mail will not be sent to this domain.
139 Patterns containing `?' and `*' can be used.
141 .TP
142 \fBset_h_from_domain\fR = \fIstring\fR
144 Replace the domain part in `From:' headers with this value.
145 This may be useful if you use a private, outside unknown address on your local LAN
146 and want this to be replaced by the domain of the address of your email addrsss on the internet.
147 Note that this is different to \fBset_return_path_domain\fR, see below.
149 .TP
150 \fBset_return_path_domain\fR = \fIstring\fR
152 Sets the domain part of the envelope from address.
153 Some hosts check whether this is the same as the net the connection is coming from.
154 If not, they reject the mail because they suspect spamming.
155 It should be a valid address, because some mail servers also check that.
156 You can also use this to set it to your usual address on the internet
157 and put a local address only known on your LAN in the configuration of your mailer.
158 Only the domain part will be changed, the local part remains unchanged.
159 Use \fBmap_return_path_addresses\fR for rewriting local parts.
161 .TP
162 \fBmap_h_from_addresses\fR = \fIlist\fR
164 This is similar to \fBset_h_from_domain\fR, but more flexible.
165 Set this to a list which maps local parts to a full RFC 822 compliant email address,
166 the local parts (the keys) are separated from the addresses (the values) by colons (`:').
168 Example:
170 map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; charlie: Charlie Miller <cmiller@mx.commercial.com>"
172 You can use patterns, eg. * as keys.
174 .TP
175 \fBmap_h_reply_to_addresses\fR = \fIlist\fR
177 Same as \fBmap_h_from_addresses\fR, but for the `Reply-To:' header.
179 .TP
180 \fBmap_h_mail_followup_to_addresses\fR = \fIlist\fR
182 Same as \fBmap_h_from_addresses\fR, but for the `Mail-Followup-To:' header.
183 Useful when replying to mailing lists.
185 .TP
186 \fBmap_return_path_addresses\fR = \fIlist\fR
188 This is similar to \fBset_return_path_domain\fR, but more flexible.
189 Set this to a list which maps local parts to a full RFC 821 compliant email address,
190 the local parts (the keys) are separated from the addresses (the values) by colons (`:').
191 Note that this option takes RFC 821 addresses while \fBmap_h_from_addresses\fR takes RFC 822 addresses.
192 The most important difference is that RFC 821 addresses have no full name.
194 Example:
196 map_return_path_addresses = "john: <jsmith@mail.academic.edu>; charlie: <cmiller@mx.commercial.com>"
198 You can use patterns, eg. * as keys.
200 .TP
201 \fBexpand_h_sender_address\fR = \fIboolean\fR
203 This sets the domain of the sender address as given by the Sender: header
204 to the same address as in the envelope return path address
205 (which can be set by either \fBset_return_path_domain\fR or \fBmap_return_path_addresses\fR).
206 This is for mail clients (eg. Microsoft Outlook) which use this address as the sender address.
207 Though they should use the From: address, see RFC 821.
208 If \fBfetchmail(1)\fR encounters an unqualified Sender: address,
209 it will be expanded to the domain of the pop server, which is almost never correct.
210 Default is true.
212 .TP
213 \fBexpand_h_sender_domain\fR = \fIboolean\fR
215 Like \fBexpand_h_sender_address\fR, but sets the domain only.
216 Deprecated, will be removed in a later version.
218 .TP
219 \fBlast_route\fR = \fIboolean\fR
221 If this is set, a mail which would have been delivered using this route,
222 but has failed temporarily, will not be tried to be delivered using the next route.
224 If you have set up a special route with filters using the lists `allowed_rcpt_domains',
225 `allowed_return_paths', and `allowed_mail_locals' or their complements (not_),
226 and the mail passing these rules should be delivered using this route only,
227 you should set this to `true'.
228 Otherwise the mail would be passed to the next route (if any),
229 unless that route has rules which prevent that.
231 Default is false.
233 .TP
234 \fBauth_name\fR = \fIstring\fR
236 Set the authentication type for ESMTP AUTH authentication.
237 Currently only `cram-md5' and `login' are supported.
239 .TP
240 \fBauth_login\fR = \fIstring\fR
242 Your account name for ESMTP AUTH authentication.
244 .TP
245 \fBauth_secret\fR = \fIstring\fR
247 Your secret for ESMTP AUTH authentication.
249 .TP
250 \fBpop3_login\fR = \fIfile\fR
252 If your Mail server requires SMTP-after-POP,
253 set this to a get configuration (see \fBmasqmail.get(5)\fR).
254 If you login to the POP server before you send, this is not necessary.
256 .TP
257 \fBwrapper\fR = \fIcommand\fR
259 If set, instead of opening a connection to a remote server,
260 \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
261 Purpose is to tunnel ip traffic, eg. for ssl.
263 Example for ssl tunneling:
265 wrapper="/usr/bin/openssl s_client \-quiet \-connect pop.gmx.net:995 2>/dev/null"
267 .TP
268 \fBpipe\fR = \fIcommand\fR
270 If set, and protocol is set to `pipe',
271 \fIcommand\fR will be called and the message will be piped to its stdin.
272 Purpose is to use gateways to uucp, fax, sms or whatever else.
274 You can use variables to give as arguments to the command,
275 these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR.
277 .TP
278 \fBpipe_fromline = \fIboolean\fR
280 If this is set, and protocol is set to `pipe',
281 a from line will be prepended to the output stream whenever a pipe command is called.
282 Default is false.
284 .TP
285 \fBpipe_fromhack = \fIboolean\fR
287 If this is set, and protocol is set to `pipe',
288 each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called.
289 You probably want this if you have set \fBpipe_fromline\fR above.
290 Default is false.
293 .SH AUTHOR
295 Masqmail was written by Oliver Kurth.
296 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
298 You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
299 There is also a mailing list, you will find information about it at masqmail's main site.
302 .SH BUGS
304 Please report bugs to the mailing list.
306 .SH SEE ALSO
308 \fBmasqmail(8)\fR, \fBmasqmail.conf(5)\fR, \fBmasqmail.get(5)\fR