1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/masqmail.route.5	Fri Sep 26 21:40:10 2008 +0200
     1.3 @@ -0,0 +1,212 @@
     1.4 +.TH masqmail.route 5 User Manuals
     1.5 +.SH NAME
     1.6 +masqmail.route \- masqmail route configuration file
     1.7 +.SH DESCRIPTION
     1.8 +
     1.9 +This man page describes the syntax of the route configuration files of \fBmasqmail (8)\f1. Their usual locations are in \fI/etc/masqmail/\f1.
    1.10 +
    1.11 +.SH OPTIONS
    1.12 +.TP
    1.13 +
    1.14 +\fBprotocol\f1 = \fIstring\f1
    1.15 +
    1.16 +\fIstring\f1 can be one of 'smtp' or 'pipe', default is 'smtp'. If set to 'smtp', mail will be sent with the SMTP protocol to its destination. If set to 'pipe', you also have to set 'pipe' to a command, the message will then be piped to a program. See option 'pipe' below.
    1.17 +.TP
    1.18 +
    1.19 +\fBmail_host\f1 = \fIstring\f1
    1.20 +
    1.21 +This is preferably the mail server of your ISP. All outgoing messages will be sent to this host which will distribute them to their destinations. If you do not set this mails will be sent directly. Because the mail server is probably 'near' to you, mail transfer will be much faster if you use it.
    1.22 +
    1.23 +You can optionally give a port number following the host name and a colon, eg mail_host="mail.foo.com:25".
    1.24 +.TP
    1.25 +
    1.26 +\fBresolve_list\f1 = \fIlist\f1
    1.27 +
    1.28 +Specify the method how the domain of the server is resolved. Possible values are dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX pointer to a list of host names, these will be tried each in order (lowest preference value first, equal preference values in random order). For 'dns_a', the domain is assumed to be an A pointer. For 'byname', the library function \fBgethostbyname (3)\f1 will be used.
    1.29 +
    1.30 +The default is "dns_mx;dns_a;byname".
    1.31 +.TP
    1.32 +
    1.33 +\fBconnect_error_fail\f1 = \fIboolean\f1
    1.34 +
    1.35 +If this is set, a connection error will cause a mail delivery to fail, ie. it will be bounced. If it is unset, it will just be defered.
    1.36 +
    1.37 +Default is false. The reason for this is that masqmail is designed for non permanent internet connections, where such errors may occur quite often, and a bounce would be annoying.
    1.38 +
    1.39 +For the default local_net route is is set to true.
    1.40 +.TP
    1.41 +
    1.42 +\fBhelo_name\f1 = \fIstring\f1
    1.43 +
    1.44 +Set the name given with the HELO/EHLO command. If this is not set, \fBhost_name\f1 from \fImasqmail.conf\f1 will be used, if the \fBdo_correct_helo\f1 option (see below) is unset.
    1.45 +.TP
    1.46 +
    1.47 +\fBdo_correct_helo\f1 = \fIboolean\f1
    1.48 +
    1.49 +If this is set, masqmail tries to look up your host name as it appears on the internet and sends this in the HELO/EHLO command. Some servers are so picky that they want this. Which is really crazy. It just does not make any sense to lie about ones own identity, because it can always be looked up by the server. Nobody should believe in the name given by HELO/EHLO anyway. If this is not set, \fBhost_name\f1 from \fImasqmail.conf\f1 or as given with the \fBhelo_name\f1 (see above) will be used.
    1.50 +.TP
    1.51 +
    1.52 +\fBdo_pipelining\f1 = \fIboolean\f1
    1.53 +
    1.54 +If this is set to false, masqmail will not use ESMTP PIPELINING, even if the server announces that it is able to cope with it. Default is true.
    1.55 +
    1.56 +You do not want to set this to false unless the mail setup on the remote server side is really broken. Keywords: wingate.
    1.57 +.TP
    1.58 +
    1.59 +\fBallowed_mail_locals\f1 = \fIlist\f1
    1.60 +
    1.61 +This is a semicolon ';' separated list of local parts which will be allowed to send mail through this connection. If unset and \fBnot_allowed_mail_locals\f1 is also unset, all users are allowed.
    1.62 +.TP
    1.63 +
    1.64 +\fBnot_allowed_mail_locals\f1 = \fIlist\f1
    1.65 +
    1.66 +This is a semicolon ';' separated list of local parts which will be not allowed to send mail through this connection. Local parts in this list will not be allowed to use this route even if they are part of \fBallowed_mail_locals\f1 (see above).
    1.67 +.TP
    1.68 +
    1.69 +\fBallowed_return_paths\f1 = \fIlist\f1
    1.70 +
    1.71 +This is a semicolon ';' separated list of addresses. Messages which have one one of these addresses as the return path will be used using this route (if not also in \fBnot_allowed_return_paths\f1 or an item in \fBnot_allowed_mail_locals\f1 matches).
    1.72 +
    1.73 +Patterns containing '?' and '*' can be used. The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
    1.74 +.TP
    1.75 +
    1.76 +\fBnot_allowed_return_paths\f1 = \fIlist\f1
    1.77 +
    1.78 +This is a semicolon ';' separated list of addresses. Messages which have one one of these addresses as the return path will not be used using this route (even if also in \fBallowed_return_paths\f1 or an item in \fBallowed_mail_locals\f1 matches).
    1.79 +
    1.80 +Patterns containing '?' and '*' can be used. The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
    1.81 +.TP
    1.82 +
    1.83 +\fBallowed_rcpt_domains\f1 = \fIlist\f1
    1.84 +
    1.85 +A list of recipient domains where mail will be sent to. This is for example useful if you use this route configuration when connected to another LAN via ppp. Patterns containing '?' and '*' can be used.
    1.86 +.TP
    1.87 +
    1.88 +\fBnot_allowed_rcpt_domains\f1 = \fIlist\f1
    1.89 +
    1.90 +A list of recipient domains where mail will not be sent to. This is for example useful if you send mail directly (\fBmail_host\f1 is not set) and you know of hosts that will not accept mail from you because they use a dialup list (eg. \fBhttp://maps.vix.com/dul/\f1. If any domain matches both \fBallowed_rcpt_domains\f1 and \fBnot_allowed_rcpt_domains\f1, mail will not be sent to this domain. Patterns containing '?' and '*' can be used.
    1.91 +.TP
    1.92 +
    1.93 +\fBset_h_from_domain\f1 = \fIstring\f1
    1.94 +
    1.95 +Replace the domain part in 'From:' headers with this value. This may be useful if you use a private, outside unknown address on your local LAN and want this to be replaced by the domain of the address of your email addrsss on the internet. Note that this is different to \fBset_return_path_domain\f1, see below.
    1.96 +.TP
    1.97 +
    1.98 +\fBset_return_path_domain\f1 = \fIstring\f1
    1.99 +
   1.100 +Sets the domain part of the envelope from address. Some hosts check whether this is the same as the net the connection is coming from. If not, they reject the mail because they suspect spamming. It should be a valid address, because some mail servers also check that. You can also use this to set it to your usual address on the internet and put a local address only known on your LAN in the configuration of your mailer. Only the domain part will be changed, the local part remains unchanged. Use \fBmap_return_path_addresses\f1 for rewriting local parts.
   1.101 +.TP
   1.102 +
   1.103 +\fBmap_h_from_addresses\f1 = \fIlist\f1
   1.104 +
   1.105 +This is similar to \fBset_h_from_domain\f1, but more flexible. Set this to a list which maps local parts to a full RFC 822 compliant email address, the local parts (the keys) are separated from the addresses (the values) by colons (':').
   1.106 +
   1.107 +Example:
   1.108 +
   1.109 +map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; charlie: Charlie Miller <cmiller@mx.commercial.com>"
   1.110 +
   1.111 +You can use patterns, eg. * as keys.
   1.112 +.TP
   1.113 +
   1.114 +\fBmap_h_reply_to_addresses\f1 = \fIlist\f1
   1.115 +
   1.116 +Same as \fBmap_h_from_addresses\f1, but for the 'Reply-To:' header.
   1.117 +.TP
   1.118 +
   1.119 +\fBmap_h_mail_followup_to_addresses\f1 = \fIlist\f1
   1.120 +
   1.121 +Same as \fBmap_h_from_addresses\f1, but for the 'Mail-Followup-To:' header. Useful when replying to mailing lists.
   1.122 +.TP
   1.123 +
   1.124 +\fBmap_return_path_addresses\f1 = \fIlist\f1
   1.125 +
   1.126 +This is similar to \fBset_return_path_domain\f1, but more flexible. Set this to a list which maps local parts to a full RFC 821 compliant email address, the local parts (the keys) are separated from the addresses (the values) by colons (':'). Note that this option takes RFC 821 addresses while \fBmap_h_from_addresses\f1 takes RFC 822 addresses. The most important difference is that RFC 821 addresses have no full name.
   1.127 +
   1.128 +Example:
   1.129 +
   1.130 +map_return_path_addresses = "john: <jsmith@mail.academic.edu>; charlie: <cmiller@mx.commercial.com>"
   1.131 +
   1.132 +You can use patterns, eg. * as keys.
   1.133 +.TP
   1.134 +
   1.135 +\fBexpand_h_sender_address\f1 = \fIboolean\f1
   1.136 +
   1.137 +This sets the domain of the sender address as given by the Sender: header to the same address as in the envelope return path address (which can be set by either \fBset_return_path_domain\f1 or \fBmap_return_path_addresses\f1). This is for mail clients (eg. Microsoft Outlook) which use this address as the sender address. Though they should use the From: address, see RFC 821. If \fBfetchmail (1)\f1 encounters an unqualified Sender: address, it will be expanded to the domain of the pop server, which is almost never correct. Default is true.
   1.138 +.TP
   1.139 +
   1.140 +\fBexpand_h_sender_domain\f1 = \fIboolean\f1
   1.141 +
   1.142 +Like \fBexpand_h_sender_address\f1, but sets the domain only. Deprecated, will be removed in a later version.
   1.143 +.TP
   1.144 +
   1.145 +\fBlast_route\f1 = \fIboolean\f1
   1.146 +
   1.147 +If this is set, a mail which would have been delivered using this route, but has failed temporarily, will not be tried to be delivered using the next route.
   1.148 +
   1.149 +If you have set up a special route with filters using the lists 'allowed_rcpt_domains', 'allowed_return_paths', and 'allowed_mail_locals' or their complements (not_), and the mail passing these rules should be delivered using this route only, you should set this to 'true'. Otherwise the mail would be passed to the next route (if any), unless that route has rules which prevent that.
   1.150 +
   1.151 +Default is false.
   1.152 +.TP
   1.153 +
   1.154 +\fBauth_name\f1 = \fIstring\f1
   1.155 +
   1.156 +Set the authentication type for ESMTP AUTH authentification. Currently only 'cram-md5' and 'login' are supported.
   1.157 +.TP
   1.158 +
   1.159 +\fBauth_login\f1 = \fIstring\f1
   1.160 +
   1.161 +Your account name for ESMTP AUTH authentification.
   1.162 +.TP
   1.163 +
   1.164 +\fBauth_secret\f1 = \fIstring\f1
   1.165 +
   1.166 +Your secret for ESMTP AUTH authentification.
   1.167 +.TP
   1.168 +
   1.169 +\fBpop3_login\f1 = \fIfile\f1
   1.170 +
   1.171 +If your Mail server requires SMTP-after-POP, set this to a get configuration (see \fBmasqmail.get (5)\f1). If you login to the POP server before you send, this is not necessary.
   1.172 +.TP
   1.173 +
   1.174 +\fBwrapper\f1 = \fIcommand\f1
   1.175 +
   1.176 +If set, instead of opening a connection to a remote server, \fIcommand\f1 will be called and all traffic will be piped to its stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.
   1.177 +
   1.178 +Example for ssl tunneling:
   1.179 +
   1.180 +wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"
   1.181 +.TP
   1.182 +
   1.183 +\fBpipe\f1 = \fIcommand\f1
   1.184 +
   1.185 +If set, and protocol is set to 'pipe', \fIcommand\f1 will be called and the message will be piped to its stdin. Purpose is to use gateways to uucp, fax, sms or whatever else.
   1.186 +
   1.187 +You can use variables to give as arguments to the command, these are the same as for the mda in the main configuration, see \fBmasqmail.conf (5)\f1.
   1.188 +.TP
   1.189 +
   1.190 +\fBpipe_fromline = \fIboolean\f1\fB\f1
   1.191 +
   1.192 +If this is set, and protocol is set to 'pipe', a from line will be prepended to the output stream whenever a pipe command is called. Default is false.
   1.193 +.TP
   1.194 +
   1.195 +\fBpipe_fromhack = \fIboolean\f1\fB\f1
   1.196 +
   1.197 +If this is set, and protocol is set to 'pipe', each line beginning with 'From ' is replaced with '>From ' whenever a pipe command is called. You probably want this if you have set \fBpipe_fromline\f1 above. Default is false.
   1.198 +.SH AUTHOR
   1.199 +
   1.200 +masqmail was written by Oliver Kurth <oku@masqmail.cx>
   1.201 +
   1.202 +You will find the newest version of masqmail at \fBhttp://masqmail.cx/masqmail/\f1 or search for it in freshmeat (\fBhttp://www.freshmeat.net\f1). There is also a mailing list, you will find information about it at masqmails main site.
   1.203 +
   1.204 +.SH BUGS
   1.205 +
   1.206 +You should report them to the mailing list.
   1.207 +
   1.208 +.SH SEE ALSO
   1.209 +
   1.210 +\fBmasqmail (8)\f1, \fBmasqmail.conf (5)\f1, \fBmasqmail.get (5)\f1
   1.211 +
   1.212 +.SH COMMENTS
   1.213 +
   1.214 +This man page was written using \fBxml2man (1)\f1 by the same author.
   1.215 +