Mercurial > masqmail
annotate man/masqmail.route.5 @ 196:413dbf3b1153
moved the CREDITS section from README to THANKS
| author | meillo@marmaro.de |
|---|---|
| date | Fri, 16 Jul 2010 10:01:49 +0200 |
| parents | 89f951be358f |
| children | 8cddc65765bd |
| rev | line source |
|---|---|
| 142 | 1 .TH masqmail.route 5 2010-07-06 masqmail-0.2.25 "File Formats" |
| 34 | 2 |
| 0 | 3 .SH NAME |
| 4 masqmail.route \- masqmail route configuration file | |
| 34 | 5 |
| 6 | |
| 0 | 7 .SH DESCRIPTION |
| 8 | |
| 34 | 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. | |
| 0 | 11 |
| 12 .SH OPTIONS | |
| 34 | 13 |
| 0 | 14 .TP |
| 34 | 15 \fBprotocol\fR = \fIstring\fR |
| 0 | 16 |
| 34 | 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. | |
| 0 | 21 |
| 34 | 22 .TP |
| 23 \fBmail_host\fR = \fIstring\fR | |
| 0 | 24 |
| 34 | 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. | |
| 0 | 29 |
| 30 You can optionally give a port number following the host name and a colon, eg mail_host="mail.foo.com:25". | |
| 34 | 31 |
| 0 | 32 .TP |
| 34 | 33 \fBresolve_list\fR = \fIlist\fR |
| 0 | 34 |
| 34 | 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. | |
| 0 | 41 |
| 42 The default is "dns_mx;dns_a;byname". | |
| 34 | 43 |
| 0 | 44 .TP |
| 34 | 45 \fBconnect_error_fail\fR = \fIboolean\fR |
| 0 | 46 |
| 34 | 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. | |
| 0 | 49 |
| 34 | 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. | |
| 0 | 53 |
|
171
15b3c71254cb
documented the wrapper option of route files better
meillo@marmaro.de
parents:
142
diff
changeset
|
54 For the default local_net route it is set to true. |
| 34 | 55 |
| 0 | 56 .TP |
| 34 | 57 \fBhelo_name\fR = \fIstring\fR |
| 0 | 58 |
| 34 | 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. | |
| 0 | 62 |
| 63 .TP | |
| 34 | 64 \fBdo_correct_helo\fR = \fIboolean\fR |
| 0 | 65 |
| 34 | 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. | |
| 0 | 75 |
| 76 .TP | |
| 34 | 77 \fBdo_pipelining\fR = \fIboolean\fR |
| 0 | 78 |
| 34 | 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. | |
| 0 | 82 |
| 34 | 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. | |
| 0 | 86 |
| 87 .TP | |
| 34 | 88 \fBallowed_mail_locals\fR = \fIlist\fR |
| 89 | |
| 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. | |
| 0 | 93 |
| 94 .TP | |
| 34 | 95 \fBnot_allowed_mail_locals\fR = \fIlist\fR |
| 0 | 96 |
| 34 | 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). | |
| 0 | 101 |
| 34 | 102 .TP |
| 103 \fBallowed_return_paths\fR = \fIlist\fR | |
| 104 | |
| 105 This is a semicolon `;' separated list of addresses. | |
| 141 | 106 Messages which have one of these addresses as the return path will be used using this route |
| 34 | 107 (if not also in \fBnot_allowed_return_paths\fR or an item in \fBnot_allowed_mail_locals\fR matches). |
| 0 | 108 |
| 34 | 109 Patterns containing `?' and `*' can be used. |
| 110 The special item "<>" matches the null sender address (eg. failure notices or delivery notifications). | |
| 0 | 111 |
| 34 | 112 .TP |
| 113 \fBnot_allowed_return_paths\fR = \fIlist\fR | |
| 0 | 114 |
| 34 | 115 This is a semicolon `;' separated list of addresses. |
| 141 | 116 Messages which have one of these addresses as the return path will not |
| 34 | 117 be used using this route (even if also in \fBallowed_return_paths\fR |
| 118 or an item in \fBallowed_mail_locals\fR matches). | |
| 0 | 119 |
| 34 | 120 Patterns containing `?' and `*' can be used. |
| 121 The special item "<>" matches the null sender address (eg. failure notices or delivery notifications). | |
| 122 | |
| 0 | 123 .TP |
| 34 | 124 \fBallowed_rcpt_domains\fR = \fIlist\fR |
| 0 | 125 |
| 34 | 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. | |
| 129 | |
| 0 | 130 .TP |
| 34 | 131 \fBnot_allowed_rcpt_domains\fR = \fIlist\fR |
| 0 | 132 |
| 34 | 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. | |
| 0 | 140 |
| 34 | 141 .TP |
| 142 \fBset_h_from_domain\fR = \fIstring\fR | |
| 0 | 143 |
| 34 | 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 | |
| 141 | 146 and want this to be replaced by the domain of the address of your email address on the internet. |
| 34 | 147 Note that this is different to \fBset_return_path_domain\fR, see below. |
| 0 | 148 |
| 149 .TP | |
|
138
80b207e8b8af
documented, yet undocumented, set_h_reply_to_domain config option
meillo@marmaro.de
parents:
95
diff
changeset
|
150 \fBset_h_reply_to_domain\fR = \fIstring\fR |
|
80b207e8b8af
documented, yet undocumented, set_h_reply_to_domain config option
meillo@marmaro.de
parents:
95
diff
changeset
|
151 |
|
80b207e8b8af
documented, yet undocumented, set_h_reply_to_domain config option
meillo@marmaro.de
parents:
95
diff
changeset
|
152 Same as \fBset_h_from_domain\fP, but for the `Reply-To' header. |
|
80b207e8b8af
documented, yet undocumented, set_h_reply_to_domain config option
meillo@marmaro.de
parents:
95
diff
changeset
|
153 |
|
80b207e8b8af
documented, yet undocumented, set_h_reply_to_domain config option
meillo@marmaro.de
parents:
95
diff
changeset
|
154 .TP |
| 34 | 155 \fBset_return_path_domain\fR = \fIstring\fR |
| 0 | 156 |
| 34 | 157 Sets the domain part of the envelope from address. |
| 158 Some hosts check whether this is the same as the net the connection is coming from. | |
| 159 If not, they reject the mail because they suspect spamming. | |
| 160 It should be a valid address, because some mail servers also check that. | |
| 161 You can also use this to set it to your usual address on the internet | |
| 162 and put a local address only known on your LAN in the configuration of your mailer. | |
| 163 Only the domain part will be changed, the local part remains unchanged. | |
| 164 Use \fBmap_return_path_addresses\fR for rewriting local parts. | |
| 0 | 165 |
| 34 | 166 .TP |
| 167 \fBmap_h_from_addresses\fR = \fIlist\fR | |
| 168 | |
| 169 This is similar to \fBset_h_from_domain\fR, but more flexible. | |
| 170 Set this to a list which maps local parts to a full RFC 822 compliant email address, | |
| 171 the local parts (the keys) are separated from the addresses (the values) by colons (`:'). | |
| 0 | 172 |
| 173 Example: | |
| 174 | |
| 175 map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; charlie: Charlie Miller <cmiller@mx.commercial.com>" | |
| 176 | |
| 177 You can use patterns, eg. * as keys. | |
| 34 | 178 |
| 0 | 179 .TP |
| 34 | 180 \fBmap_h_reply_to_addresses\fR = \fIlist\fR |
| 0 | 181 |
| 34 | 182 Same as \fBmap_h_from_addresses\fR, but for the `Reply-To:' header. |
| 0 | 183 |
| 184 .TP | |
| 34 | 185 \fBmap_h_mail_followup_to_addresses\fR = \fIlist\fR |
| 0 | 186 |
| 34 | 187 Same as \fBmap_h_from_addresses\fR, but for the `Mail-Followup-To:' header. |
| 188 Useful when replying to mailing lists. | |
| 0 | 189 |
| 190 .TP | |
| 34 | 191 \fBmap_return_path_addresses\fR = \fIlist\fR |
| 0 | 192 |
| 34 | 193 This is similar to \fBset_return_path_domain\fR, but more flexible. |
| 194 Set this to a list which maps local parts to a full RFC 821 compliant email address, | |
| 195 the local parts (the keys) are separated from the addresses (the values) by colons (`:'). | |
| 196 Note that this option takes RFC 821 addresses while \fBmap_h_from_addresses\fR takes RFC 822 addresses. | |
| 197 The most important difference is that RFC 821 addresses have no full name. | |
| 0 | 198 |
| 199 Example: | |
| 200 | |
| 201 map_return_path_addresses = "john: <jsmith@mail.academic.edu>; charlie: <cmiller@mx.commercial.com>" | |
| 202 | |
| 203 You can use patterns, eg. * as keys. | |
| 34 | 204 |
| 0 | 205 .TP |
| 34 | 206 \fBexpand_h_sender_address\fR = \fIboolean\fR |
| 0 | 207 |
| 34 | 208 This sets the domain of the sender address as given by the Sender: header |
| 209 to the same address as in the envelope return path address | |
| 210 (which can be set by either \fBset_return_path_domain\fR or \fBmap_return_path_addresses\fR). | |
| 211 This is for mail clients (eg. Microsoft Outlook) which use this address as the sender address. | |
| 212 Though they should use the From: address, see RFC 821. | |
| 213 If \fBfetchmail(1)\fR encounters an unqualified Sender: address, | |
| 214 it will be expanded to the domain of the pop server, which is almost never correct. | |
| 215 Default is true. | |
| 216 | |
| 0 | 217 .TP |
| 34 | 218 \fBexpand_h_sender_domain\fR = \fIboolean\fR |
| 0 | 219 |
| 34 | 220 Like \fBexpand_h_sender_address\fR, but sets the domain only. |
| 221 Deprecated, will be removed in a later version. | |
| 222 | |
| 0 | 223 .TP |
| 34 | 224 \fBlast_route\fR = \fIboolean\fR |
| 0 | 225 |
| 34 | 226 If this is set, a mail which would have been delivered using this route, |
| 227 but has failed temporarily, will not be tried to be delivered using the next route. | |
| 0 | 228 |
| 34 | 229 If you have set up a special route with filters using the lists `allowed_rcpt_domains', |
| 230 `allowed_return_paths', and `allowed_mail_locals' or their complements (not_), | |
| 231 and the mail passing these rules should be delivered using this route only, | |
| 232 you should set this to `true'. | |
| 233 Otherwise the mail would be passed to the next route (if any), | |
| 234 unless that route has rules which prevent that. | |
| 0 | 235 |
| 236 Default is false. | |
| 34 | 237 |
| 0 | 238 .TP |
| 34 | 239 \fBauth_name\fR = \fIstring\fR |
| 0 | 240 |
| 34 | 241 Set the authentication type for ESMTP AUTH authentication. |
| 242 Currently only `cram-md5' and `login' are supported. | |
| 243 | |
| 0 | 244 .TP |
| 34 | 245 \fBauth_login\fR = \fIstring\fR |
| 0 | 246 |
| 24 | 247 Your account name for ESMTP AUTH authentication. |
| 34 | 248 |
| 0 | 249 .TP |
| 34 | 250 \fBauth_secret\fR = \fIstring\fR |
| 0 | 251 |
| 24 | 252 Your secret for ESMTP AUTH authentication. |
| 34 | 253 |
| 0 | 254 .TP |
| 34 | 255 \fBwrapper\fR = \fIcommand\fR |
| 0 | 256 |
| 34 | 257 If set, instead of opening a connection to a remote server, |
| 258 \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout. | |
| 259 Purpose is to tunnel ip traffic, eg. for ssl. | |
| 0 | 260 |
| 261 Example for ssl tunneling: | |
| 262 | |
|
180
1472a6a73b1c
do *not* use the openssl option -crlf in a wrapper command
meillo@marmaro.de
parents:
171
diff
changeset
|
263 wrapper="/usr/bin/openssl s_client \-quiet \-connect mail.gmx.net:465 2>/dev/null" |
|
171
15b3c71254cb
documented the wrapper option of route files better
meillo@marmaro.de
parents:
142
diff
changeset
|
264 |
|
15b3c71254cb
documented the wrapper option of route files better
meillo@marmaro.de
parents:
142
diff
changeset
|
265 Note: The above line works with masqmail, |
|
15b3c71254cb
documented the wrapper option of route files better
meillo@marmaro.de
parents:
142
diff
changeset
|
266 but listening on Port 465 for SSL-encrypted connections is deprecated. |
|
15b3c71254cb
documented the wrapper option of route files better
meillo@marmaro.de
parents:
142
diff
changeset
|
267 The modern way is STARTTLS (RFC-3207). |
|
15b3c71254cb
documented the wrapper option of route files better
meillo@marmaro.de
parents:
142
diff
changeset
|
268 This could be covered by the following command. |
|
15b3c71254cb
documented the wrapper option of route files better
meillo@marmaro.de
parents:
142
diff
changeset
|
269 Unfortunately, masqmail doesn't support that yet (as of 0.2.25). |
|
15b3c71254cb
documented the wrapper option of route files better
meillo@marmaro.de
parents:
142
diff
changeset
|
270 |
|
180
1472a6a73b1c
do *not* use the openssl option -crlf in a wrapper command
meillo@marmaro.de
parents:
171
diff
changeset
|
271 wrapper="/usr/bin/openssl s_client \-quiet \-starttls smtp \-connect mail.gmx.net:25 2>/dev/null" |
|
1472a6a73b1c
do *not* use the openssl option -crlf in a wrapper command
meillo@marmaro.de
parents:
171
diff
changeset
|
272 |
|
1472a6a73b1c
do *not* use the openssl option -crlf in a wrapper command
meillo@marmaro.de
parents:
171
diff
changeset
|
273 Note for openssl: |
|
1472a6a73b1c
do *not* use the openssl option -crlf in a wrapper command
meillo@marmaro.de
parents:
171
diff
changeset
|
274 Ensure that stderr is redirected. |
|
1472a6a73b1c
do *not* use the openssl option -crlf in a wrapper command
meillo@marmaro.de
parents:
171
diff
changeset
|
275 Do *not* use \-crlf in the wrapper command, because masqmail does already insert CRLF. |
|
1472a6a73b1c
do *not* use the openssl option -crlf in a wrapper command
meillo@marmaro.de
parents:
171
diff
changeset
|
276 However, you might want to specify \-crlf if you want to test your wrapper command |
|
1472a6a73b1c
do *not* use the openssl option -crlf in a wrapper command
meillo@marmaro.de
parents:
171
diff
changeset
|
277 interactively on the command line. |
| 34 | 278 |
| 0 | 279 .TP |
| 34 | 280 \fBpipe\fR = \fIcommand\fR |
| 0 | 281 |
| 34 | 282 If set, and protocol is set to `pipe', |
| 283 \fIcommand\fR will be called and the message will be piped to its stdin. | |
| 284 Purpose is to use gateways to uucp, fax, sms or whatever else. | |
| 0 | 285 |
| 34 | 286 You can use variables to give as arguments to the command, |
| 287 these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR. | |
| 288 | |
| 0 | 289 .TP |
| 34 | 290 \fBpipe_fromline = \fIboolean\fR |
| 0 | 291 |
| 34 | 292 If this is set, and protocol is set to `pipe', |
| 293 a from line will be prepended to the output stream whenever a pipe command is called. | |
| 294 Default is false. | |
| 0 | 295 |
| 296 .TP | |
| 34 | 297 \fBpipe_fromhack = \fIboolean\fR |
| 0 | 298 |
| 34 | 299 If this is set, and protocol is set to `pipe', |
| 300 each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called. | |
| 301 You probably want this if you have set \fBpipe_fromline\fR above. | |
| 302 Default is false. | |
| 0 | 303 |
| 34 | 304 |
| 0 | 305 .SH AUTHOR |
| 306 | |
| 34 | 307 Masqmail was written by Oliver Kurth. |
| 308 It is now maintained by Markus Schnalke <meillo@marmaro.de>. | |
| 0 | 309 |
|
95
e01fed4846e4
masqmail's homepage moved prog.marmaro.de/masqmail -> marmaro.de/prog/masqmail
meillo@marmaro.de
parents:
57
diff
changeset
|
310 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR. |
|
26
607221b0dac1
added myself as maintainer; updated URL of the website
meillo@marmaro.de
parents:
24
diff
changeset
|
311 There is also a mailing list, you will find information about it at masqmail's main site. |
| 0 | 312 |
| 34 | 313 |
| 0 | 314 .SH BUGS |
| 315 | |
| 34 | 316 Please report bugs to the mailing list. |
| 0 | 317 |
| 318 .SH SEE ALSO | |
| 319 | |
| 192 | 320 \fBmasqmail(8)\fR, \fBmasqmail.conf(5)\fR |