docs/diploma

annotate docs/masqmail.cx/docs/masqmail.route.5.html @ 1:7b2a5fe2aedd

added old website masqmail.cx
author meillo@marmaro.de
date Thu, 18 Sep 2008 18:57:02 +0200
parents
children
rev   line source
meillo@1 1 <body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%">
meillo@1 2 <tr><td><h1>masqmail.route</h1>
meillo@1 3 <h2>masqmail route configuration file</h2>
meillo@1 4
meillo@1 5
meillo@1 6 <h2>Description</h2>
meillo@1 7
meillo@1 8 <p>This man page describes the syntax of the route configuration files
meillo@1 9 of <a href="masqmail.8.html">masqmail</a>. Their usual locations are in <em>/etc/masqmail/</em>.</p>
meillo@1 10
meillo@1 11
meillo@1 12
meillo@1 13 <h2>Options</h2>
meillo@1 14
meillo@1 15
meillo@1 16
meillo@1 17 <p><b>protocol</b> = <em>string</em></p>
meillo@1 18
meillo@1 19 <p><em>string</em> can be one of 'smtp' or 'pipe', default is
meillo@1 20 'smtp'. If set to 'smtp', mail will be sent with the SMTP protocol to
meillo@1 21 its destination. If set to 'pipe', you also have to set 'pipe'
meillo@1 22 to a command, the message will then be piped to a program. See option 'pipe' below.</p>
meillo@1 23
meillo@1 24
meillo@1 25
meillo@1 26
meillo@1 27 <p><b>mail_host</b> = <em>string</em></p>
meillo@1 28
meillo@1 29 <p>This is preferably the mail server of your ISP. All outgoing
meillo@1 30 messages will be sent to this host which will distribute them to their
meillo@1 31 destinations. If you do not set this mails will be sent
meillo@1 32 directly. Because the mail server is probably 'near' to you, mail
meillo@1 33 transfer will be much faster if you use it.</p>
meillo@1 34 <p>You can optionally give a port number following the host name
meillo@1 35 and a colon, eg mail_host="mail.foo.com:25".</p>
meillo@1 36
meillo@1 37
meillo@1 38
meillo@1 39
meillo@1 40 <p><b>resolve_list</b> = <em>list</em></p>
meillo@1 41
meillo@1 42 <p>Specify the method how the domain of the server is resolved. Possible values are
meillo@1 43 dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX
meillo@1 44 pointer to a list of host names, these will be tried each in order
meillo@1 45 (lowest preference value first, equal preference values in random
meillo@1 46 order). For 'dns_a', the domain is assumed to be an A pointer. For
meillo@1 47 'byname', the library function <b>gethostbyname (3)</b> will be used.</p>
meillo@1 48 <p>The default is "dns_mx;dns_a;byname".</p>
meillo@1 49
meillo@1 50
meillo@1 51
meillo@1 52
meillo@1 53 <p><b>connect_error_fail</b> = <em>boolean</em></p>
meillo@1 54
meillo@1 55 <p>If this is set, a connection error will cause a mail delivery to
meillo@1 56 fail, ie. it will be bounced. If it is unset, it will just be defered.</p>
meillo@1 57 <p>Default is false. The reason for this is that masqmail is designed
meillo@1 58 for non permanent internet connections, where such errors may occur
meillo@1 59 quite often, and a bounce would be annoying.</p>
meillo@1 60 <p>For the default local_net route is is set to true.</p>
meillo@1 61
meillo@1 62
meillo@1 63
meillo@1 64
meillo@1 65 <p><b>helo_name</b> = <em>string</em></p>
meillo@1 66
meillo@1 67 <p>Set the name given with the HELO/EHLO command. If this is not
meillo@1 68 set, <b>host_name</b> from <em>masqmail.conf</em> will be used, if
meillo@1 69 the <b>do_correct_helo</b> option (see below) is unset.</p>
meillo@1 70
meillo@1 71
meillo@1 72
meillo@1 73
meillo@1 74 <p><b>do_correct_helo</b> = <em>boolean</em></p>
meillo@1 75
meillo@1 76 <p>If this is set, masqmail tries to look up your host name as it
meillo@1 77 appears on the internet and sends this in the HELO/EHLO command. Some
meillo@1 78 servers are so picky that they want this. Which is really
meillo@1 79 crazy. It just does not make any sense to lie about ones own identity,
meillo@1 80 because it can always be looked up by the server. Nobody should
meillo@1 81 believe in the name given by HELO/EHLO anyway. If this is not
meillo@1 82 set, <b>host_name</b> from <em>masqmail.conf</em> or as given with
meillo@1 83 the <b>helo_name</b> (see above) will be used.</p>
meillo@1 84
meillo@1 85
meillo@1 86
meillo@1 87
meillo@1 88 <p><b>do_pipelining</b> = <em>boolean</em></p>
meillo@1 89
meillo@1 90 <p>If this is set to false, masqmail will not use ESMTP PIPELINING, even
meillo@1 91 if the server announces that it is able to cope with it. Default is true.</p>
meillo@1 92 <p>You do not want to set this to false unless the mail setup on the
meillo@1 93 remote server side is really broken. Keywords: wingate.</p>
meillo@1 94
meillo@1 95
meillo@1 96
meillo@1 97
meillo@1 98 <p><b>allowed_mail_locals</b> = <em>list</em></p>
meillo@1 99
meillo@1 100 <p>This is a semicolon ';' separated list of local parts which will be
meillo@1 101 allowed to send mail through this connection. If unset
meillo@1 102 and <b>not_allowed_mail_locals</b> is also unset, all users are
meillo@1 103 allowed.</p>
meillo@1 104
meillo@1 105
meillo@1 106
meillo@1 107
meillo@1 108 <p><b>not_allowed_mail_locals</b> = <em>list</em></p>
meillo@1 109
meillo@1 110 <p>This is a semicolon ';' separated list of local parts which will be
meillo@1 111 not allowed to send mail through this connection. Local
meillo@1 112 parts in this list will not be allowed to use this route even if they
meillo@1 113 are part of <b>allowed_mail_locals</b> (see above).</p>
meillo@1 114
meillo@1 115
meillo@1 116
meillo@1 117
meillo@1 118 <p><b>allowed_return_paths</b> = <em>list</em></p>
meillo@1 119
meillo@1 120 <p>This is a semicolon ';' separated list of addresses. Messages which
meillo@1 121 have one one of these addresses as the return path will be used using
meillo@1 122 this route (if not also in <b>not_allowed_return_paths</b> or an item
meillo@1 123 in <b>not_allowed_mail_locals</b> matches).</p>
meillo@1 124 <p>Patterns containing '?' and '*' can be used. The special item "<>" matches
meillo@1 125 the null sender address (eg. failure notices or delivery notifications).</p>
meillo@1 126
meillo@1 127
meillo@1 128
meillo@1 129
meillo@1 130 <p><b>not_allowed_return_paths</b> = <em>list</em></p>
meillo@1 131
meillo@1 132 <p>This is a semicolon ';' separated list of addresses. Messages which
meillo@1 133 have one one of these addresses as the return path will not be used using
meillo@1 134 this route (even if also in <b>allowed_return_paths</b> or an item
meillo@1 135 in <b>allowed_mail_locals</b> matches).</p>
meillo@1 136 <p>Patterns containing '?' and '*' can be used. The special item "<>" matches
meillo@1 137 the null sender address (eg. failure notices or delivery notifications).</p>
meillo@1 138
meillo@1 139
meillo@1 140
meillo@1 141
meillo@1 142 <p><b>allowed_rcpt_domains</b> = <em>list</em></p>
meillo@1 143
meillo@1 144 <p>A list of recipient domains where mail will be sent to. This is for
meillo@1 145 example useful if you use this route configuration when connected to
meillo@1 146 another LAN via ppp. Patterns containing '?' and '*' can be used.</p>
meillo@1 147
meillo@1 148
meillo@1 149
meillo@1 150
meillo@1 151 <p><b>not_allowed_rcpt_domains</b> = <em>list</em></p>
meillo@1 152
meillo@1 153 <p>A list of recipient domains where mail will not be sent
meillo@1 154 to. This is for example useful if you send mail directly (<b>mail_host</b> is
meillo@1 155 not set) and you know of hosts that will not accept mail from you
meillo@1 156 because they use a dialup list (eg. <a href = "http://maps.vix.com/dul/">http://maps.vix.com/dul/</a>. If any domain
meillo@1 157 matches both <b>allowed_rcpt_domains</b> and <b>not_allowed_rcpt_domains</b>,
meillo@1 158 mail will not be sent to this domain. Patterns containing '?' and '*' can be used.</p>
meillo@1 159
meillo@1 160
meillo@1 161
meillo@1 162
meillo@1 163 <p><b>set_h_from_domain</b> = <em>string</em></p>
meillo@1 164
meillo@1 165 <p>Replace the domain part in 'From:' headers with this value. This
meillo@1 166 may be useful if you use a private, outside unknown address on your
meillo@1 167 local LAN and want this to be replaced by the domain of the address of
meillo@1 168 your email addrsss on the internet. Note that this is different to <b>
meillo@1 169 set_return_path_domain</b>, see below.</p>
meillo@1 170
meillo@1 171
meillo@1 172
meillo@1 173
meillo@1 174 <p><b>set_return_path_domain</b> = <em>string</em></p>
meillo@1 175
meillo@1 176 <p>Sets the domain part of the envelope from address. Some hosts check
meillo@1 177 whether this is the same as the net the connection is coming from. If
meillo@1 178 not, they reject the mail because they suspect spamming. It should be
meillo@1 179 a valid address, because some mail servers also check
meillo@1 180 that. You can also use this to set it to your usual address on the
meillo@1 181 internet and put a local address only known on your LAN in the
meillo@1 182 configuration of your mailer. Only the domain part will
meillo@1 183 be changed, the local part remains unchanged. Use <b>
meillo@1 184 map_return_path_addresses</b> for rewriting local parts.</p>
meillo@1 185
meillo@1 186
meillo@1 187
meillo@1 188
meillo@1 189 <p><b>map_h_from_addresses</b> = <em>list</em></p>
meillo@1 190
meillo@1 191 <p>This is similar to <b>set_h_from_domain</b>, but more flexible. Set
meillo@1 192 this to a list which maps local parts to a full RFC 822 compliant
meillo@1 193 email address, the local parts (the keys) are separated from
meillo@1 194 the addresses (the values) by colons (':').</p>
meillo@1 195
meillo@1 196 <p>Example:</p>
meillo@1 197
meillo@1 198 <p>map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>;
meillo@1 199 charlie: Charlie Miller <cmiller@mx.commercial.com>"</p>
meillo@1 200 <p>You can use patterns, eg. * as keys.</p>
meillo@1 201
meillo@1 202
meillo@1 203
meillo@1 204
meillo@1 205 <p><b>map_h_reply_to_addresses</b> = <em>list</em></p>
meillo@1 206
meillo@1 207 <p>Same as <b>map_h_from_addresses</b>, but for the 'Reply-To:' header.</p>
meillo@1 208
meillo@1 209
meillo@1 210
meillo@1 211
meillo@1 212 <p><b>map_h_mail_followup_to_addresses</b> = <em>list</em></p>
meillo@1 213
meillo@1 214 <p>Same as <b>map_h_from_addresses</b>, but for the 'Mail-Followup-To:'
meillo@1 215 header. Useful when replying to mailing lists.</p>
meillo@1 216
meillo@1 217
meillo@1 218
meillo@1 219
meillo@1 220 <p><b>map_return_path_addresses</b> = <em>list</em></p>
meillo@1 221
meillo@1 222 <p>This is similar to <b>set_return_path_domain</b>, but more
meillo@1 223 flexible. Set this to a list which maps local parts to a full RFC 821
meillo@1 224 compliant email address, the local parts (the keys) are
meillo@1 225 separated from the addresses (the values) by colons
meillo@1 226 (':'). Note that this option takes RFC 821 addresses
meillo@1 227 while <b>map_h_from_addresses</b> takes RFC 822 addresses. The
meillo@1 228 most important difference is that RFC 821 addresses have no full
meillo@1 229 name.</p>
meillo@1 230
meillo@1 231 <p>Example:</p>
meillo@1 232 <p>
meillo@1 233 map_return_path_addresses =
meillo@1 234 "john: <jsmith@mail.academic.edu>;
meillo@1 235 charlie: <cmiller@mx.commercial.com>"
meillo@1 236 </p>
meillo@1 237 <p>You can use patterns, eg. * as keys.</p>
meillo@1 238
meillo@1 239
meillo@1 240
meillo@1 241
meillo@1 242 <p><b>expand_h_sender_address</b> = <em>boolean</em></p>
meillo@1 243
meillo@1 244 <p>This sets the domain of the sender address as given by the Sender:
meillo@1 245 header to the same address as in the envelope return path address
meillo@1 246 (which can be set by either <b>set_return_path_domain</b> or <b>map_return_path_addresses</b>).
meillo@1 247 This is for mail clients (eg. Microsoft Outlook) which use this address as the sender
meillo@1 248 address. Though they should use the From: address, see RFC
meillo@1 249 821. If <a href="http://www.fetchmail.org">fetchmail</a> encounters an unqualified Sender:
meillo@1 250 address, it will be expanded to the domain of the pop server, which is
meillo@1 251 almost never correct. Default is true.</p>
meillo@1 252
meillo@1 253
meillo@1 254
meillo@1 255
meillo@1 256 <p><b>expand_h_sender_domain</b> = <em>boolean</em></p>
meillo@1 257
meillo@1 258 <p>Like <b>expand_h_sender_address</b>, but sets the domain only.
meillo@1 259 Deprecated, will be removed in a later version.</p>
meillo@1 260
meillo@1 261
meillo@1 262
meillo@1 263
meillo@1 264 <p><b>last_route</b> = <em>boolean</em></p>
meillo@1 265
meillo@1 266 <p>If this is set, a mail which would have been delivered using this
meillo@1 267 route, but has failed temporarily, will not be tried to be delivered
meillo@1 268 using the next route.</p>
meillo@1 269 <p>If you have set up a special route with filters using the lists
meillo@1 270 'allowed_rcpt_domains', 'allowed_return_paths', and
meillo@1 271 'allowed_mail_locals' or their complements (not_), and the mail
meillo@1 272 passing these rules should be delivered using this route only, you
meillo@1 273 should set this to 'true'. Otherwise the mail would be passed to the
meillo@1 274 next route (if any), unless that route has rules which prevent
meillo@1 275 that.</p>
meillo@1 276 <p>Default is false.</p>
meillo@1 277
meillo@1 278
meillo@1 279
meillo@1 280
meillo@1 281 <p><b>auth_name</b> = <em>string</em></p>
meillo@1 282
meillo@1 283 <p>Set the authentication type for ESMTP AUTH authentification.
meillo@1 284 Currently only 'cram-md5' and 'login' are supported.</p>
meillo@1 285
meillo@1 286
meillo@1 287
meillo@1 288
meillo@1 289 <p><b>auth_login</b> = <em>string</em></p>
meillo@1 290
meillo@1 291 <p>Your account name for ESMTP AUTH authentification.</p>
meillo@1 292
meillo@1 293
meillo@1 294
meillo@1 295
meillo@1 296 <p><b>auth_secret</b> = <em>string</em></p>
meillo@1 297
meillo@1 298 <p>Your secret for ESMTP AUTH authentification.</p>
meillo@1 299
meillo@1 300
meillo@1 301
meillo@1 302
meillo@1 303 <p><b>pop3_login</b> = <em>file</em></p>
meillo@1 304
meillo@1 305 <p>If your Mail server requires SMTP-after-POP, set this to a
meillo@1 306 get configuration (see <a href="masqmail.get.5.html">masqmail.get</a>).
meillo@1 307 If you login to the POP server
meillo@1 308 before you send, this is not necessary.</p>
meillo@1 309
meillo@1 310
meillo@1 311
meillo@1 312
meillo@1 313 <p><b>wrapper</b> = <em>command</em></p>
meillo@1 314
meillo@1 315 <p>If set, instead of opening a connection to a remote server, <em>command</em> will
meillo@1 316 be called and all traffic will be piped to its
meillo@1 317 stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.</p>
meillo@1 318 <p>Example for ssl tunneling:</p>
meillo@1 319 <p>wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"</p>
meillo@1 320
meillo@1 321
meillo@1 322
meillo@1 323
meillo@1 324 <p><b>pipe</b> = <em>command</em></p>
meillo@1 325
meillo@1 326 <p>If set, and protocol is set to 'pipe', <em>command</em> will be
meillo@1 327 called and the message will be piped to its stdin. Purpose is to use
meillo@1 328 gateways to uucp, fax, sms or whatever else.</p>
meillo@1 329 <p>You can use variables to give as arguments to the command, these
meillo@1 330 are the same as for the mda in the main configuration, see <a href="masqmail.conf.5.html">masqmail.conf</a>.</p>
meillo@1 331
meillo@1 332
meillo@1 333
meillo@1 334
meillo@1 335 <p><b>pipe_fromline = <em>boolean</em></b></p>
meillo@1 336
meillo@1 337 <p>If this is set, and protocol is set to 'pipe', a from line will be prepended to the output stream whenever
meillo@1 338 a pipe command is called. Default is false.</p>
meillo@1 339
meillo@1 340
meillo@1 341
meillo@1 342
meillo@1 343 <p><b>pipe_fromhack = <em>boolean</em></b></p>
meillo@1 344
meillo@1 345 <p>If this is set, and protocol is set to 'pipe', each line beginning with 'From '
meillo@1 346 is replaced with '>From ' whenever a pipe command is called. You probably want this if you have
meillo@1 347 set <b>pipe_fromline</b> above. Default is false.</p>
meillo@1 348
meillo@1 349
meillo@1 350
meillo@1 351
meillo@1 352
meillo@1 353 <h2>Author</h2>
meillo@1 354
meillo@1 355 <p>masqmail was written by Oliver Kurth
meillo@1 356 <oku@masqmail.cx></p><p>You will find the newest version of
meillo@1 357 masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it
meillo@1 358 in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list,
meillo@1 359 you will find information about it at masqmails main site.</p>
meillo@1 360
meillo@1 361
meillo@1 362
meillo@1 363 <h2>Bugs</h2>
meillo@1 364
meillo@1 365 <p>You should report them to the mailing list.</p>
meillo@1 366
meillo@1 367
meillo@1 368
meillo@1 369 <h2>See also</h2>
meillo@1 370
meillo@1 371 <p>
meillo@1 372 <a href="masqmail.8.html">masqmail</a>, <a href="masqmail.conf.5.html">masqmail.conf</a>, <a href="masqmail.get.5.html">masqmail.get</a>
meillo@1 373 </p>
meillo@1 374
meillo@1 375
meillo@1 376
meillo@1 377 <h2>Comments</h2>
meillo@1 378
meillo@1 379 <p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same
meillo@1 380 author.</p>
meillo@1 381
meillo@1 382
meillo@1 383
meillo@1 384 </td></tr></table></center>
meillo@1 385 </body>