masqmail-0.2
diff docs/old-manual/docs/masqmail.route.5.html @ 56:f6a6f55b7b9e
added old manual from the old website
it is dated May/July 2000
| author | meillo@marmaro.de |
|---|---|
| date | Sat, 29 May 2010 21:51:13 +0200 |
| parents | |
| children |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/docs/old-manual/docs/masqmail.route.5.html Sat May 29 21:51:13 2010 +0200 1.3 @@ -0,0 +1,385 @@ 1.4 +<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%"> 1.5 +<tr><td><h1>masqmail.route</h1> 1.6 +<h2>masqmail route configuration file</h2> 1.7 + 1.8 + 1.9 +<h2>Description</h2> 1.10 + 1.11 +<p>This man page describes the syntax of the route configuration files 1.12 +of <a href="masqmail.8.html">masqmail</a>. Their usual locations are in <em>/etc/masqmail/</em>.</p> 1.13 + 1.14 + 1.15 + 1.16 +<h2>Options</h2> 1.17 + 1.18 + 1.19 + 1.20 +<p><b>protocol</b> = <em>string</em></p> 1.21 + 1.22 +<p><em>string</em> can be one of 'smtp' or 'pipe', default is 1.23 +'smtp'. If set to 'smtp', mail will be sent with the SMTP protocol to 1.24 +its destination. If set to 'pipe', you also have to set 'pipe' 1.25 +to a command, the message will then be piped to a program. See option 'pipe' below.</p> 1.26 + 1.27 + 1.28 + 1.29 + 1.30 +<p><b>mail_host</b> = <em>string</em></p> 1.31 + 1.32 +<p>This is preferably the mail server of your ISP. All outgoing 1.33 +messages will be sent to this host which will distribute them to their 1.34 +destinations. If you do not set this mails will be sent 1.35 +directly. Because the mail server is probably 'near' to you, mail 1.36 +transfer will be much faster if you use it.</p> 1.37 +<p>You can optionally give a port number following the host name 1.38 +and a colon, eg mail_host="mail.foo.com:25".</p> 1.39 + 1.40 + 1.41 + 1.42 + 1.43 +<p><b>resolve_list</b> = <em>list</em></p> 1.44 + 1.45 +<p>Specify the method how the domain of the server is resolved. Possible values are 1.46 +dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX 1.47 +pointer to a list of host names, these will be tried each in order 1.48 +(lowest preference value first, equal preference values in random 1.49 +order). For 'dns_a', the domain is assumed to be an A pointer. For 1.50 +'byname', the library function <b>gethostbyname (3)</b> will be used.</p> 1.51 +<p>The default is "dns_mx;dns_a;byname".</p> 1.52 + 1.53 + 1.54 + 1.55 + 1.56 +<p><b>connect_error_fail</b> = <em>boolean</em></p> 1.57 + 1.58 +<p>If this is set, a connection error will cause a mail delivery to 1.59 +fail, ie. it will be bounced. If it is unset, it will just be defered.</p> 1.60 +<p>Default is false. The reason for this is that masqmail is designed 1.61 +for non permanent internet connections, where such errors may occur 1.62 +quite often, and a bounce would be annoying.</p> 1.63 +<p>For the default local_net route is is set to true.</p> 1.64 + 1.65 + 1.66 + 1.67 + 1.68 +<p><b>helo_name</b> = <em>string</em></p> 1.69 + 1.70 +<p>Set the name given with the HELO/EHLO command. If this is not 1.71 +set, <b>host_name</b> from <em>masqmail.conf</em> will be used, if 1.72 +the <b>do_correct_helo</b> option (see below) is unset.</p> 1.73 + 1.74 + 1.75 + 1.76 + 1.77 +<p><b>do_correct_helo</b> = <em>boolean</em></p> 1.78 + 1.79 +<p>If this is set, masqmail tries to look up your host name as it 1.80 +appears on the internet and sends this in the HELO/EHLO command. Some 1.81 +servers are so picky that they want this. Which is really 1.82 +crazy. It just does not make any sense to lie about ones own identity, 1.83 +because it can always be looked up by the server. Nobody should 1.84 +believe in the name given by HELO/EHLO anyway. If this is not 1.85 +set, <b>host_name</b> from <em>masqmail.conf</em> or as given with 1.86 +the <b>helo_name</b> (see above) will be used.</p> 1.87 + 1.88 + 1.89 + 1.90 + 1.91 +<p><b>do_pipelining</b> = <em>boolean</em></p> 1.92 + 1.93 +<p>If this is set to false, masqmail will not use ESMTP PIPELINING, even 1.94 +if the server announces that it is able to cope with it. Default is true.</p> 1.95 +<p>You do not want to set this to false unless the mail setup on the 1.96 +remote server side is really broken. Keywords: wingate.</p> 1.97 + 1.98 + 1.99 + 1.100 + 1.101 +<p><b>allowed_mail_locals</b> = <em>list</em></p> 1.102 + 1.103 +<p>This is a semicolon ';' separated list of local parts which will be 1.104 +allowed to send mail through this connection. If unset 1.105 +and <b>not_allowed_mail_locals</b> is also unset, all users are 1.106 +allowed.</p> 1.107 + 1.108 + 1.109 + 1.110 + 1.111 +<p><b>not_allowed_mail_locals</b> = <em>list</em></p> 1.112 + 1.113 +<p>This is a semicolon ';' separated list of local parts which will be 1.114 +not allowed to send mail through this connection. Local 1.115 +parts in this list will not be allowed to use this route even if they 1.116 +are part of <b>allowed_mail_locals</b> (see above).</p> 1.117 + 1.118 + 1.119 + 1.120 + 1.121 +<p><b>allowed_return_paths</b> = <em>list</em></p> 1.122 + 1.123 +<p>This is a semicolon ';' separated list of addresses. Messages which 1.124 +have one one of these addresses as the return path will be used using 1.125 +this route (if not also in <b>not_allowed_return_paths</b> or an item 1.126 +in <b>not_allowed_mail_locals</b> matches).</p> 1.127 +<p>Patterns containing '?' and '*' can be used. The special item "<>" matches 1.128 +the null sender address (eg. failure notices or delivery notifications).</p> 1.129 + 1.130 + 1.131 + 1.132 + 1.133 +<p><b>not_allowed_return_paths</b> = <em>list</em></p> 1.134 + 1.135 +<p>This is a semicolon ';' separated list of addresses. Messages which 1.136 +have one one of these addresses as the return path will not be used using 1.137 +this route (even if also in <b>allowed_return_paths</b> or an item 1.138 +in <b>allowed_mail_locals</b> matches).</p> 1.139 +<p>Patterns containing '?' and '*' can be used. The special item "<>" matches 1.140 +the null sender address (eg. failure notices or delivery notifications).</p> 1.141 + 1.142 + 1.143 + 1.144 + 1.145 +<p><b>allowed_rcpt_domains</b> = <em>list</em></p> 1.146 + 1.147 +<p>A list of recipient domains where mail will be sent to. This is for 1.148 +example useful if you use this route configuration when connected to 1.149 +another LAN via ppp. Patterns containing '?' and '*' can be used.</p> 1.150 + 1.151 + 1.152 + 1.153 + 1.154 +<p><b>not_allowed_rcpt_domains</b> = <em>list</em></p> 1.155 + 1.156 +<p>A list of recipient domains where mail will not be sent 1.157 +to. This is for example useful if you send mail directly (<b>mail_host</b> is 1.158 +not set) and you know of hosts that will not accept mail from you 1.159 +because they use a dialup list (eg. <a href = "http://maps.vix.com/dul/">http://maps.vix.com/dul/</a>. If any domain 1.160 +matches both <b>allowed_rcpt_domains</b> and <b>not_allowed_rcpt_domains</b>, 1.161 +mail will not be sent to this domain. Patterns containing '?' and '*' can be used.</p> 1.162 + 1.163 + 1.164 + 1.165 + 1.166 +<p><b>set_h_from_domain</b> = <em>string</em></p> 1.167 + 1.168 +<p>Replace the domain part in 'From:' headers with this value. This 1.169 +may be useful if you use a private, outside unknown address on your 1.170 +local LAN and want this to be replaced by the domain of the address of 1.171 +your email addrsss on the internet. Note that this is different to <b> 1.172 +set_return_path_domain</b>, see below.</p> 1.173 + 1.174 + 1.175 + 1.176 + 1.177 +<p><b>set_return_path_domain</b> = <em>string</em></p> 1.178 + 1.179 +<p>Sets the domain part of the envelope from address. Some hosts check 1.180 +whether this is the same as the net the connection is coming from. If 1.181 +not, they reject the mail because they suspect spamming. It should be 1.182 +a valid address, because some mail servers also check 1.183 +that. You can also use this to set it to your usual address on the 1.184 +internet and put a local address only known on your LAN in the 1.185 +configuration of your mailer. Only the domain part will 1.186 +be changed, the local part remains unchanged. Use <b> 1.187 +map_return_path_addresses</b> for rewriting local parts.</p> 1.188 + 1.189 + 1.190 + 1.191 + 1.192 +<p><b>map_h_from_addresses</b> = <em>list</em></p> 1.193 + 1.194 +<p>This is similar to <b>set_h_from_domain</b>, but more flexible. Set 1.195 +this to a list which maps local parts to a full RFC 822 compliant 1.196 +email address, the local parts (the keys) are separated from 1.197 +the addresses (the values) by colons (':').</p> 1.198 + 1.199 +<p>Example:</p> 1.200 + 1.201 +<p>map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; 1.202 +charlie: Charlie Miller <cmiller@mx.commercial.com>"</p> 1.203 +<p>You can use patterns, eg. * as keys.</p> 1.204 + 1.205 + 1.206 + 1.207 + 1.208 +<p><b>map_h_reply_to_addresses</b> = <em>list</em></p> 1.209 + 1.210 +<p>Same as <b>map_h_from_addresses</b>, but for the 'Reply-To:' header.</p> 1.211 + 1.212 + 1.213 + 1.214 + 1.215 +<p><b>map_h_mail_followup_to_addresses</b> = <em>list</em></p> 1.216 + 1.217 +<p>Same as <b>map_h_from_addresses</b>, but for the 'Mail-Followup-To:' 1.218 +header. Useful when replying to mailing lists.</p> 1.219 + 1.220 + 1.221 + 1.222 + 1.223 +<p><b>map_return_path_addresses</b> = <em>list</em></p> 1.224 + 1.225 +<p>This is similar to <b>set_return_path_domain</b>, but more 1.226 +flexible. Set this to a list which maps local parts to a full RFC 821 1.227 +compliant email address, the local parts (the keys) are 1.228 +separated from the addresses (the values) by colons 1.229 +(':'). Note that this option takes RFC 821 addresses 1.230 +while <b>map_h_from_addresses</b> takes RFC 822 addresses. The 1.231 +most important difference is that RFC 821 addresses have no full 1.232 +name.</p> 1.233 + 1.234 +<p>Example:</p> 1.235 +<p> 1.236 +map_return_path_addresses = 1.237 +"john: <jsmith@mail.academic.edu>; 1.238 +charlie: <cmiller@mx.commercial.com>" 1.239 +</p> 1.240 +<p>You can use patterns, eg. * as keys.</p> 1.241 + 1.242 + 1.243 + 1.244 + 1.245 +<p><b>expand_h_sender_address</b> = <em>boolean</em></p> 1.246 + 1.247 +<p>This sets the domain of the sender address as given by the Sender: 1.248 +header to the same address as in the envelope return path address 1.249 +(which can be set by either <b>set_return_path_domain</b> or <b>map_return_path_addresses</b>). 1.250 +This is for mail clients (eg. Microsoft Outlook) which use this address as the sender 1.251 +address. Though they should use the From: address, see RFC 1.252 +821. If <a href="http://www.fetchmail.org">fetchmail</a> encounters an unqualified Sender: 1.253 +address, it will be expanded to the domain of the pop server, which is 1.254 +almost never correct. Default is true.</p> 1.255 + 1.256 + 1.257 + 1.258 + 1.259 +<p><b>expand_h_sender_domain</b> = <em>boolean</em></p> 1.260 + 1.261 +<p>Like <b>expand_h_sender_address</b>, but sets the domain only. 1.262 +Deprecated, will be removed in a later version.</p> 1.263 + 1.264 + 1.265 + 1.266 + 1.267 +<p><b>last_route</b> = <em>boolean</em></p> 1.268 + 1.269 +<p>If this is set, a mail which would have been delivered using this 1.270 +route, but has failed temporarily, will not be tried to be delivered 1.271 +using the next route.</p> 1.272 +<p>If you have set up a special route with filters using the lists 1.273 +'allowed_rcpt_domains', 'allowed_return_paths', and 1.274 +'allowed_mail_locals' or their complements (not_), and the mail 1.275 +passing these rules should be delivered using this route only, you 1.276 +should set this to 'true'. Otherwise the mail would be passed to the 1.277 +next route (if any), unless that route has rules which prevent 1.278 +that.</p> 1.279 +<p>Default is false.</p> 1.280 + 1.281 + 1.282 + 1.283 + 1.284 +<p><b>auth_name</b> = <em>string</em></p> 1.285 + 1.286 +<p>Set the authentication type for ESMTP AUTH authentification. 1.287 +Currently only 'cram-md5' and 'login' are supported.</p> 1.288 + 1.289 + 1.290 + 1.291 + 1.292 +<p><b>auth_login</b> = <em>string</em></p> 1.293 + 1.294 +<p>Your account name for ESMTP AUTH authentification.</p> 1.295 + 1.296 + 1.297 + 1.298 + 1.299 +<p><b>auth_secret</b> = <em>string</em></p> 1.300 + 1.301 +<p>Your secret for ESMTP AUTH authentification.</p> 1.302 + 1.303 + 1.304 + 1.305 + 1.306 +<p><b>pop3_login</b> = <em>file</em></p> 1.307 + 1.308 +<p>If your Mail server requires SMTP-after-POP, set this to a 1.309 +get configuration (see <a href="masqmail.get.5.html">masqmail.get</a>). 1.310 +If you login to the POP server 1.311 +before you send, this is not necessary.</p> 1.312 + 1.313 + 1.314 + 1.315 + 1.316 +<p><b>wrapper</b> = <em>command</em></p> 1.317 + 1.318 +<p>If set, instead of opening a connection to a remote server, <em>command</em> will 1.319 +be called and all traffic will be piped to its 1.320 +stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.</p> 1.321 +<p>Example for ssl tunneling:</p> 1.322 +<p>wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"</p> 1.323 + 1.324 + 1.325 + 1.326 + 1.327 +<p><b>pipe</b> = <em>command</em></p> 1.328 + 1.329 +<p>If set, and protocol is set to 'pipe', <em>command</em> will be 1.330 +called and the message will be piped to its stdin. Purpose is to use 1.331 +gateways to uucp, fax, sms or whatever else.</p> 1.332 +<p>You can use variables to give as arguments to the command, these 1.333 +are the same as for the mda in the main configuration, see <a href="masqmail.conf.5.html">masqmail.conf</a>.</p> 1.334 + 1.335 + 1.336 + 1.337 + 1.338 +<p><b>pipe_fromline = <em>boolean</em></b></p> 1.339 + 1.340 +<p>If this is set, and protocol is set to 'pipe', a from line will be prepended to the output stream whenever 1.341 +a pipe command is called. Default is false.</p> 1.342 + 1.343 + 1.344 + 1.345 + 1.346 +<p><b>pipe_fromhack = <em>boolean</em></b></p> 1.347 + 1.348 +<p>If this is set, and protocol is set to 'pipe', each line beginning with 'From ' 1.349 +is replaced with '>From ' whenever a pipe command is called. You probably want this if you have 1.350 +set <b>pipe_fromline</b> above. Default is false.</p> 1.351 + 1.352 + 1.353 + 1.354 + 1.355 + 1.356 +<h2>Author</h2> 1.357 + 1.358 +<p>masqmail was written by Oliver Kurth 1.359 +<oku@masqmail.cx></p><p>You will find the newest version of 1.360 +masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it 1.361 +in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list, 1.362 +you will find information about it at masqmails main site.</p> 1.363 + 1.364 + 1.365 + 1.366 +<h2>Bugs</h2> 1.367 + 1.368 +<p>You should report them to the mailing list.</p> 1.369 + 1.370 + 1.371 + 1.372 +<h2>See also</h2> 1.373 + 1.374 +<p> 1.375 +<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> 1.376 +</p> 1.377 + 1.378 + 1.379 + 1.380 +<h2>Comments</h2> 1.381 + 1.382 +<p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same 1.383 +author.</p> 1.384 + 1.385 + 1.386 + 1.387 +</td></tr></table></center> 1.388 +</body>