meillo@1:
meillo@1:

masqmail.route

meillo@1:

masqmail route configuration file

meillo@1: meillo@1: meillo@1:

Description

meillo@1: meillo@1:

This man page describes the syntax of the route configuration files meillo@1: of masqmail. Their usual locations are in /etc/masqmail/.

meillo@1: meillo@1: meillo@1: meillo@1:

Options

meillo@1: meillo@1: meillo@1: meillo@1:

protocol = string

meillo@1: meillo@1:

string can be one of 'smtp' or 'pipe', default is meillo@1: 'smtp'. If set to 'smtp', mail will be sent with the SMTP protocol to meillo@1: its destination. If set to 'pipe', you also have to set 'pipe' meillo@1: to a command, the message will then be piped to a program. See option 'pipe' below.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

mail_host = string

meillo@1: meillo@1:

This is preferably the mail server of your ISP. All outgoing meillo@1: messages will be sent to this host which will distribute them to their meillo@1: destinations. If you do not set this mails will be sent meillo@1: directly. Because the mail server is probably 'near' to you, mail meillo@1: transfer will be much faster if you use it.

meillo@1:

You can optionally give a port number following the host name meillo@1: and a colon, eg mail_host="mail.foo.com:25".

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

resolve_list = list

meillo@1: meillo@1:

Specify the method how the domain of the server is resolved. Possible values are meillo@1: dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX meillo@1: pointer to a list of host names, these will be tried each in order meillo@1: (lowest preference value first, equal preference values in random meillo@1: order). For 'dns_a', the domain is assumed to be an A pointer. For meillo@1: 'byname', the library function gethostbyname (3) will be used.

meillo@1:

The default is "dns_mx;dns_a;byname".

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

connect_error_fail = boolean

meillo@1: meillo@1:

If this is set, a connection error will cause a mail delivery to meillo@1: fail, ie. it will be bounced. If it is unset, it will just be defered.

meillo@1:

Default is false. The reason for this is that masqmail is designed meillo@1: for non permanent internet connections, where such errors may occur meillo@1: quite often, and a bounce would be annoying.

meillo@1:

For the default local_net route is is set to true.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

helo_name = string

meillo@1: meillo@1:

Set the name given with the HELO/EHLO command. If this is not meillo@1: set, host_name from masqmail.conf will be used, if meillo@1: the do_correct_helo option (see below) is unset.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

do_correct_helo = boolean

meillo@1: meillo@1:

If this is set, masqmail tries to look up your host name as it meillo@1: appears on the internet and sends this in the HELO/EHLO command. Some meillo@1: servers are so picky that they want this. Which is really meillo@1: crazy. It just does not make any sense to lie about ones own identity, meillo@1: because it can always be looked up by the server. Nobody should meillo@1: believe in the name given by HELO/EHLO anyway. If this is not meillo@1: set, host_name from masqmail.conf or as given with meillo@1: the helo_name (see above) will be used.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

do_pipelining = boolean

meillo@1: meillo@1:

If this is set to false, masqmail will not use ESMTP PIPELINING, even meillo@1: if the server announces that it is able to cope with it. Default is true.

meillo@1:

You do not want to set this to false unless the mail setup on the meillo@1: remote server side is really broken. Keywords: wingate.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

allowed_mail_locals = list

meillo@1: meillo@1:

This is a semicolon ';' separated list of local parts which will be meillo@1: allowed to send mail through this connection. If unset meillo@1: and not_allowed_mail_locals is also unset, all users are meillo@1: allowed.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

not_allowed_mail_locals = list

meillo@1: meillo@1:

This is a semicolon ';' separated list of local parts which will be meillo@1: not allowed to send mail through this connection. Local meillo@1: parts in this list will not be allowed to use this route even if they meillo@1: are part of allowed_mail_locals (see above).

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

allowed_return_paths = list

meillo@1: meillo@1:

This is a semicolon ';' separated list of addresses. Messages which meillo@1: have one one of these addresses as the return path will be used using meillo@1: this route (if not also in not_allowed_return_paths or an item meillo@1: in not_allowed_mail_locals matches).

meillo@1:

Patterns containing '?' and '*' can be used. The special item "<>" matches meillo@1: the null sender address (eg. failure notices or delivery notifications).

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

not_allowed_return_paths = list

meillo@1: meillo@1:

This is a semicolon ';' separated list of addresses. Messages which meillo@1: have one one of these addresses as the return path will not be used using meillo@1: this route (even if also in allowed_return_paths or an item meillo@1: in allowed_mail_locals matches).

meillo@1:

Patterns containing '?' and '*' can be used. The special item "<>" matches meillo@1: the null sender address (eg. failure notices or delivery notifications).

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

allowed_rcpt_domains = list

meillo@1: meillo@1:

A list of recipient domains where mail will be sent to. This is for meillo@1: example useful if you use this route configuration when connected to meillo@1: another LAN via ppp. Patterns containing '?' and '*' can be used.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

not_allowed_rcpt_domains = list

meillo@1: meillo@1:

A list of recipient domains where mail will not be sent meillo@1: to. This is for example useful if you send mail directly (mail_host is meillo@1: not set) and you know of hosts that will not accept mail from you meillo@1: because they use a dialup list (eg. http://maps.vix.com/dul/. If any domain meillo@1: matches both allowed_rcpt_domains and not_allowed_rcpt_domains, meillo@1: mail will not be sent to this domain. Patterns containing '?' and '*' can be used.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

set_h_from_domain = string

meillo@1: meillo@1:

Replace the domain part in 'From:' headers with this value. This meillo@1: may be useful if you use a private, outside unknown address on your meillo@1: local LAN and want this to be replaced by the domain of the address of meillo@1: your email addrsss on the internet. Note that this is different to meillo@1: set_return_path_domain, see below.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

set_return_path_domain = string

meillo@1: meillo@1:

Sets the domain part of the envelope from address. Some hosts check meillo@1: whether this is the same as the net the connection is coming from. If meillo@1: not, they reject the mail because they suspect spamming. It should be meillo@1: a valid address, because some mail servers also check meillo@1: that. You can also use this to set it to your usual address on the meillo@1: internet and put a local address only known on your LAN in the meillo@1: configuration of your mailer. Only the domain part will meillo@1: be changed, the local part remains unchanged. Use meillo@1: map_return_path_addresses for rewriting local parts.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

map_h_from_addresses = list

meillo@1: meillo@1:

This is similar to set_h_from_domain, but more flexible. Set meillo@1: this to a list which maps local parts to a full RFC 822 compliant meillo@1: email address, the local parts (the keys) are separated from meillo@1: the addresses (the values) by colons (':').

meillo@1: meillo@1:

Example:

meillo@1: meillo@1:

map_h_from_addresses = "john: John Smith ; meillo@1: charlie: Charlie Miller "

meillo@1:

You can use patterns, eg. * as keys.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

map_h_reply_to_addresses = list

meillo@1: meillo@1:

Same as map_h_from_addresses, but for the 'Reply-To:' header.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

map_h_mail_followup_to_addresses = list

meillo@1: meillo@1:

Same as map_h_from_addresses, but for the 'Mail-Followup-To:' meillo@1: header. Useful when replying to mailing lists.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

map_return_path_addresses = list

meillo@1: meillo@1:

This is similar to set_return_path_domain, but more meillo@1: flexible. Set this to a list which maps local parts to a full RFC 821 meillo@1: compliant email address, the local parts (the keys) are meillo@1: separated from the addresses (the values) by colons meillo@1: (':'). Note that this option takes RFC 821 addresses meillo@1: while map_h_from_addresses takes RFC 822 addresses. The meillo@1: most important difference is that RFC 821 addresses have no full meillo@1: name.

meillo@1: meillo@1:

Example:

meillo@1:

meillo@1: map_return_path_addresses = meillo@1: "john: ; meillo@1: charlie: " meillo@1:

meillo@1:

You can use patterns, eg. * as keys.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

expand_h_sender_address = boolean

meillo@1: meillo@1:

This sets the domain of the sender address as given by the Sender: meillo@1: header to the same address as in the envelope return path address meillo@1: (which can be set by either set_return_path_domain or map_return_path_addresses). meillo@1: This is for mail clients (eg. Microsoft Outlook) which use this address as the sender meillo@1: address. Though they should use the From: address, see RFC meillo@1: 821. If fetchmail encounters an unqualified Sender: meillo@1: address, it will be expanded to the domain of the pop server, which is meillo@1: almost never correct. Default is true.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

expand_h_sender_domain = boolean

meillo@1: meillo@1:

Like expand_h_sender_address, but sets the domain only. meillo@1: Deprecated, will be removed in a later version.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

last_route = boolean

meillo@1: meillo@1:

If this is set, a mail which would have been delivered using this meillo@1: route, but has failed temporarily, will not be tried to be delivered meillo@1: using the next route.

meillo@1:

If you have set up a special route with filters using the lists meillo@1: 'allowed_rcpt_domains', 'allowed_return_paths', and meillo@1: 'allowed_mail_locals' or their complements (not_), and the mail meillo@1: passing these rules should be delivered using this route only, you meillo@1: should set this to 'true'. Otherwise the mail would be passed to the meillo@1: next route (if any), unless that route has rules which prevent meillo@1: that.

meillo@1:

Default is false.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

auth_name = string

meillo@1: meillo@1:

Set the authentication type for ESMTP AUTH authentification. meillo@1: Currently only 'cram-md5' and 'login' are supported.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

auth_login = string

meillo@1: meillo@1:

Your account name for ESMTP AUTH authentification.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

auth_secret = string

meillo@1: meillo@1:

Your secret for ESMTP AUTH authentification.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

pop3_login = file

meillo@1: meillo@1:

If your Mail server requires SMTP-after-POP, set this to a meillo@1: get configuration (see masqmail.get). meillo@1: If you login to the POP server meillo@1: before you send, this is not necessary.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

wrapper = command

meillo@1: meillo@1:

If set, instead of opening a connection to a remote server, command will meillo@1: be called and all traffic will be piped to its meillo@1: stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.

meillo@1:

Example for ssl tunneling:

meillo@1:

wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

pipe = command

meillo@1: meillo@1:

If set, and protocol is set to 'pipe', command will be meillo@1: called and the message will be piped to its stdin. Purpose is to use meillo@1: gateways to uucp, fax, sms or whatever else.

meillo@1:

You can use variables to give as arguments to the command, these meillo@1: are the same as for the mda in the main configuration, see masqmail.conf.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

pipe_fromline = boolean

meillo@1: meillo@1:

If this is set, and protocol is set to 'pipe', a from line will be prepended to the output stream whenever meillo@1: a pipe command is called. Default is false.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

pipe_fromhack = boolean

meillo@1: meillo@1:

If this is set, and protocol is set to 'pipe', each line beginning with 'From ' meillo@1: is replaced with '>From ' whenever a pipe command is called. You probably want this if you have meillo@1: set pipe_fromline above. Default is false.

meillo@1: meillo@1: meillo@1: meillo@1: meillo@1: meillo@1:

Author

meillo@1: meillo@1:

masqmail was written by Oliver Kurth meillo@1:

You will find the newest version of meillo@1: masqmail at http://masqmail.cx/masqmail/ or search for it meillo@1: in freshmeat (http://www.freshmeat.net). There is also a mailing list, meillo@1: you will find information about it at masqmails main site.

meillo@1: meillo@1: meillo@1: meillo@1:

Bugs

meillo@1: meillo@1:

You should report them to the mailing list.

meillo@1: meillo@1: meillo@1: meillo@1:

See also

meillo@1: meillo@1:

meillo@1: masqmail, masqmail.conf, masqmail.get meillo@1:

meillo@1: meillo@1: meillo@1: meillo@1:

Comments

meillo@1: meillo@1:

This man page was written using xml2man by the same meillo@1: author.

meillo@1: meillo@1: meillo@1: meillo@1:
meillo@1: