meillo@142: .TH masqmail.route 5 2010-07-06 masqmail-0.2.25 "File Formats"
meillo@34: 
meillo@0: .SH NAME
meillo@0: masqmail.route \- masqmail route configuration file
meillo@34: 
meillo@34: 
meillo@0: .SH DESCRIPTION
meillo@0: 
meillo@34: This man page describes the syntax of the route configuration files of \fBmasqmail (8)\fR.
meillo@34: Their usual locations are in \fI/etc/masqmail/\fR.
meillo@0: 
meillo@0: .SH OPTIONS
meillo@34: 
meillo@0: .TP
meillo@34: \fBprotocol\fR = \fIstring\fR
meillo@0: 
meillo@34: \fIstring\fR can be one of `smtp' or `pipe', default is `smtp'.
meillo@34: If set to `smtp', mail will be sent with the SMTP protocol to its destination.
meillo@34: If set to `pipe', you also have to set `pipe' to a command, the message will then be piped to a program.
meillo@34: See option `pipe' below.
meillo@0: 
meillo@0: .TP
meillo@34: \fBmail_host\fR = \fIstring\fR
meillo@0: 
meillo@34: This is preferably the mail server of your ISP.
meillo@34: All outgoing messages will be sent to this host which will distribute them to their destinations.
meillo@34: If you do not set this mails will be sent directly.
meillo@34: Because the mail server is probably `near' to you, mail transfer will be much faster if you use it.
meillo@0: 
meillo@0: You can optionally give a port number following the host name and a colon, eg mail_host="mail.foo.com:25".
meillo@34: 
meillo@0: .TP
meillo@34: \fBresolve_list\fR = \fIlist\fR
meillo@0: 
meillo@34: Specify the method how the domain of the server is resolved.
meillo@34: Possible values are dns_mx, dns_a, byname.
meillo@34: For `dns_mx', the domain is assumed to be an MX pointer to a list of host names,
meillo@34: these will be tried each in order (lowest preference value first, equal preference values in random order).
meillo@34: For `dns_a', the domain is assumed to be an A pointer.
meillo@34: For `byname', the library function \fBgethostbyname(3)\fR will be used.
meillo@0: 
meillo@0: The default is "dns_mx;dns_a;byname".
meillo@34: 
meillo@0: .TP
meillo@34: \fBconnect_error_fail\fR = \fIboolean\fR
meillo@0: 
meillo@34: If this is set, a connection error will cause a mail delivery to fail, ie. it will be bounced.
meillo@34: If it is unset, it will just be defered.
meillo@0: 
meillo@34: Default is false.
meillo@34: The reason for this is that masqmail is designed for non permanent internet connections,
meillo@34: where such errors may occur quite often, and a bounce would be annoying.
meillo@0: 
meillo@0: For the default local_net route is is set to true.
meillo@34: 
meillo@0: .TP
meillo@34: \fBhelo_name\fR = \fIstring\fR
meillo@0: 
meillo@34: Set the name given with the HELO/EHLO command. If this is not set,
meillo@34: \fBhost_name\fR from \fImasqmail.conf\fR will be used,
meillo@34: if the \fBdo_correct_helo\fR option (see below) is unset.
meillo@0: 
meillo@0: .TP
meillo@34: \fBdo_correct_helo\fR = \fIboolean\fR
meillo@0: 
meillo@34: If this is set, masqmail tries to look up your host name as it appears
meillo@34: on the internet and sends this in the HELO/EHLO command.
meillo@34: Some servers are so picky that they want this.
meillo@34: Which is really crazy.
meillo@34: It just does not make any sense to lie about ones own identity,
meillo@34: because it can always be looked up by the server.
meillo@34: Nobody should believe in the name given by HELO/EHLO anyway.
meillo@34: If this is not set, \fBhost_name\fR from \fImasqmail.conf\fR or as given with
meillo@34: the \fBhelo_name\fR (see above) will be used.
meillo@0: 
meillo@0: .TP
meillo@34: \fBdo_pipelining\fR = \fIboolean\fR
meillo@0: 
meillo@34: If this is set to false, masqmail will not use ESMTP PIPELINING,
meillo@34: even if the server announces that it is able to cope with it.
meillo@34: Default is true.
meillo@0: 
meillo@34: You do not want to set this to false unless the mail setup on the
meillo@34: remote server side is really broken.
meillo@34: Keywords: wingate.
meillo@0: 
meillo@0: .TP
meillo@34: \fBallowed_mail_locals\fR = \fIlist\fR
meillo@0: 
meillo@34: This is a semicolon `;' separated list of local parts which will be allowed
meillo@34: to send mail through this connection.
meillo@34: If unset and \fBnot_allowed_mail_locals\fR is also unset, all users are allowed.
meillo@0: 
meillo@0: .TP
meillo@34: \fBnot_allowed_mail_locals\fR = \fIlist\fR
meillo@0: 
meillo@34: This is a semicolon `;' separated list of local parts which will be not allowed
meillo@34: to send mail through this connection.
meillo@34: Local parts in this list will not be allowed to use this route even if they
meillo@34: are part of \fBallowed_mail_locals\fR (see above).
meillo@0: 
meillo@0: .TP
meillo@34: \fBallowed_return_paths\fR = \fIlist\fR
meillo@0: 
meillo@34: This is a semicolon `;' separated list of addresses.
meillo@141: Messages which have one of these addresses as the return path will be used using this route
meillo@34: (if not also in \fBnot_allowed_return_paths\fR or an item in \fBnot_allowed_mail_locals\fR matches).
meillo@0: 
meillo@34: Patterns containing `?' and `*' can be used.
meillo@34: The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
meillo@0: 
meillo@0: .TP
meillo@34: \fBnot_allowed_return_paths\fR = \fIlist\fR
meillo@0: 
meillo@34: This is a semicolon `;' separated list of addresses.
meillo@141: Messages which have one of these addresses as the return path will not
meillo@34: be used using this route (even if also in \fBallowed_return_paths\fR
meillo@34: or an item in \fBallowed_mail_locals\fR matches).
meillo@0: 
meillo@34: Patterns containing `?' and `*' can be used.
meillo@34: The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
meillo@0: 
meillo@0: .TP
meillo@34: \fBallowed_rcpt_domains\fR = \fIlist\fR
meillo@0: 
meillo@34: A list of recipient domains where mail will be sent to.
meillo@34: This is for example useful if you use this route configuration when connected to another LAN via ppp.
meillo@34: Patterns containing `?' and `*' can be used.
meillo@0: 
meillo@0: .TP
meillo@34: \fBnot_allowed_rcpt_domains\fR = \fIlist\fR
meillo@0: 
meillo@34: A list of recipient domains where mail will not be sent to.
meillo@34: This is for example useful if you send mail directly (\fBmail_host\fR is not set)
meillo@34: and you know of hosts that will not accept mail from you because they use a dialup list
meillo@34: (eg. \fBhttp://maps.vix.com/dul/\fR).
meillo@34: If any domain matches both \fBallowed_rcpt_domains\fR and \fBnot_allowed_rcpt_domains\fR,
meillo@34: mail will not be sent to this domain.
meillo@34: Patterns containing `?' and `*' can be used.
meillo@0: 
meillo@0: .TP
meillo@34: \fBset_h_from_domain\fR = \fIstring\fR
meillo@0: 
meillo@34: Replace the domain part in `From:' headers with this value.
meillo@34: This may be useful if you use a private, outside unknown address on your local LAN
meillo@141: and want this to be replaced by the domain of the address of your email address on the internet.
meillo@34: Note that this is different to \fBset_return_path_domain\fR, see below.
meillo@0: 
meillo@0: .TP
meillo@138: \fBset_h_reply_to_domain\fR = \fIstring\fR
meillo@138: 
meillo@138: Same as \fBset_h_from_domain\fP, but for the `Reply-To' header.
meillo@138: 
meillo@138: .TP
meillo@34: \fBset_return_path_domain\fR = \fIstring\fR
meillo@0: 
meillo@34: Sets the domain part of the envelope from address.
meillo@34: Some hosts check whether this is the same as the net the connection is coming from.
meillo@34: If not, they reject the mail because they suspect spamming.
meillo@34: It should be a valid address, because some mail servers also check that.
meillo@34: You can also use this to set it to your usual address on the internet
meillo@34: and put a local address only known on your LAN in the configuration of your mailer.
meillo@34: Only the domain part will be changed, the local part remains unchanged.
meillo@34: Use \fBmap_return_path_addresses\fR for rewriting local parts.
meillo@0: 
meillo@0: .TP
meillo@34: \fBmap_h_from_addresses\fR = \fIlist\fR
meillo@0: 
meillo@34: This is similar to \fBset_h_from_domain\fR, but more flexible.
meillo@34: Set this to a list which maps local parts to a full RFC 822 compliant email address,
meillo@34: the local parts (the keys) are separated from the addresses (the values) by colons (`:').
meillo@0: 
meillo@0: Example:
meillo@0: 
meillo@0: map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; charlie: Charlie Miller <cmiller@mx.commercial.com>"
meillo@0: 
meillo@0: You can use patterns, eg. * as keys.
meillo@34: 
meillo@0: .TP
meillo@34: \fBmap_h_reply_to_addresses\fR = \fIlist\fR
meillo@0: 
meillo@34: Same as \fBmap_h_from_addresses\fR, but for the `Reply-To:' header.
meillo@0: 
meillo@0: .TP
meillo@34: \fBmap_h_mail_followup_to_addresses\fR = \fIlist\fR
meillo@0: 
meillo@34: Same as \fBmap_h_from_addresses\fR, but for the `Mail-Followup-To:' header.
meillo@34: Useful when replying to mailing lists.
meillo@0: 
meillo@0: .TP
meillo@34: \fBmap_return_path_addresses\fR = \fIlist\fR
meillo@0: 
meillo@34: This is similar to \fBset_return_path_domain\fR, but more flexible.
meillo@34: Set this to a list which maps local parts to a full RFC 821 compliant email address,
meillo@34: the local parts (the keys) are separated from the addresses (the values) by colons (`:').
meillo@34: Note that this option takes RFC 821 addresses while \fBmap_h_from_addresses\fR takes RFC 822 addresses.
meillo@34: The most important difference is that RFC 821 addresses have no full name.
meillo@0: 
meillo@0: Example:
meillo@0: 
meillo@0: map_return_path_addresses = "john: <jsmith@mail.academic.edu>; charlie: <cmiller@mx.commercial.com>"
meillo@0: 
meillo@0: You can use patterns, eg. * as keys.
meillo@34: 
meillo@0: .TP
meillo@34: \fBexpand_h_sender_address\fR = \fIboolean\fR
meillo@0: 
meillo@34: This sets the domain of the sender address as given by the Sender: header
meillo@34: to the same address as in the envelope return path address
meillo@34: (which can be set by either \fBset_return_path_domain\fR or \fBmap_return_path_addresses\fR).
meillo@34: This is for mail clients (eg. Microsoft Outlook) which use this address as the sender address.
meillo@34: Though they should use the From: address, see RFC 821.
meillo@34: If \fBfetchmail(1)\fR encounters an unqualified Sender: address,
meillo@34: it will be expanded to the domain of the pop server, which is almost never correct.
meillo@34: Default is true.
meillo@0: 
meillo@0: .TP
meillo@34: \fBexpand_h_sender_domain\fR = \fIboolean\fR
meillo@0: 
meillo@34: Like \fBexpand_h_sender_address\fR, but sets the domain only.
meillo@34: Deprecated, will be removed in a later version.
meillo@0: 
meillo@0: .TP
meillo@34: \fBlast_route\fR = \fIboolean\fR
meillo@0: 
meillo@34: If this is set, a mail which would have been delivered using this route,
meillo@34: but has failed temporarily, will not be tried to be delivered using the next route.
meillo@0: 
meillo@34: If you have set up a special route with filters using the lists `allowed_rcpt_domains',
meillo@34: `allowed_return_paths', and `allowed_mail_locals' or their complements (not_),
meillo@34: and the mail passing these rules should be delivered using this route only,
meillo@34: you should set this to `true'.
meillo@34: Otherwise the mail would be passed to the next route (if any),
meillo@34: unless that route has rules which prevent that.
meillo@0: 
meillo@0: Default is false.
meillo@34: 
meillo@0: .TP
meillo@34: \fBauth_name\fR = \fIstring\fR
meillo@0: 
meillo@34: Set the authentication type for ESMTP AUTH authentication.
meillo@34: Currently only `cram-md5' and `login' are supported.
meillo@0: 
meillo@0: .TP
meillo@34: \fBauth_login\fR = \fIstring\fR
meillo@0: 
meillo@24: Your account name for ESMTP AUTH authentication.
meillo@34: 
meillo@0: .TP
meillo@34: \fBauth_secret\fR = \fIstring\fR
meillo@0: 
meillo@24: Your secret for ESMTP AUTH authentication.
meillo@34: 
meillo@0: .TP
meillo@34: \fBpop3_login\fR = \fIfile\fR
meillo@0: 
meillo@34: If your Mail server requires SMTP-after-POP,
meillo@34: set this to a get configuration (see \fBmasqmail.get(5)\fR).
meillo@34: If you login to the POP server before you send, this is not necessary.
meillo@0: 
meillo@0: .TP
meillo@34: \fBwrapper\fR = \fIcommand\fR
meillo@0: 
meillo@34: If set, instead of opening a connection to a remote server,
meillo@34: \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
meillo@34: Purpose is to tunnel ip traffic, eg. for ssl.
meillo@0: 
meillo@0: Example for ssl tunneling:
meillo@0: 
meillo@16: wrapper="/usr/bin/openssl s_client \-quiet \-connect pop.gmx.net:995 2>/dev/null"
meillo@34: 
meillo@0: .TP
meillo@34: \fBpipe\fR = \fIcommand\fR
meillo@0: 
meillo@34: If set, and protocol is set to `pipe',
meillo@34: \fIcommand\fR will be called and the message will be piped to its stdin.
meillo@34: Purpose is to use gateways to uucp, fax, sms or whatever else.
meillo@0: 
meillo@34: You can use variables to give as arguments to the command,
meillo@34: these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR.
meillo@0: 
meillo@0: .TP
meillo@34: \fBpipe_fromline = \fIboolean\fR
meillo@0: 
meillo@34: If this is set, and protocol is set to `pipe',
meillo@34: a from line will be prepended to the output stream whenever a pipe command is called.
meillo@34: Default is false.
meillo@0: 
meillo@0: .TP
meillo@34: \fBpipe_fromhack = \fIboolean\fR
meillo@0: 
meillo@34: If this is set, and protocol is set to `pipe',
meillo@34: each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called.
meillo@34: You probably want this if you have set \fBpipe_fromline\fR above.
meillo@34: Default is false.
meillo@0: 
meillo@34: 
meillo@0: .SH AUTHOR
meillo@0: 
meillo@34: Masqmail was written by Oliver Kurth.
meillo@34: It is now maintained by Markus Schnalke <meillo@marmaro.de>.
meillo@0: 
meillo@95: You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
meillo@26: There is also a mailing list, you will find information about it at masqmail's main site.
meillo@0: 
meillo@34: 
meillo@0: .SH BUGS
meillo@0: 
meillo@34: Please report bugs to the mailing list.
meillo@0: 
meillo@0: .SH SEE ALSO
meillo@0: 
meillo@34: \fBmasqmail(8)\fR, \fBmasqmail.conf(5)\fR, \fBmasqmail.get(5)\fR