masqmail

annotate man/masqmail.route.5 @ 196:413dbf3b1153

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