meillo@56: meillo@56: meillo@56: meillo@56: meillo@56: meillo@56: meillo@56: meillo@56: meillo@56: meillo@56: meillo@56: MasqMail - Manual meillo@56: meillo@56: meillo@56: meillo@56: meillo@56:
meillo@56: meillo@56: meillo@56: meillo@56:
meillo@56: meillo@56: meillo@56: meillo@56: meillo@56: meillo@56: meillo@56: meillo@56:
meillo@56: meillo@56: manual meillo@56: meillo@56: Configuration meillo@56: meillo@56: Alias Format meillo@56: meillo@56: meillo@56: meillo@56: Frequently Asked Questions meillo@56: meillo@56:
meillo@56: meillo@56: meillo@56:

The configuration consists of lines of the form

meillo@56: meillo@56: val = expression meillo@56: meillo@56:

Where val is a variable name and expression a string, meillo@56: which can be quoted with '"'. If the expression is on multiple lines meillo@56: or contains characters other than letters, digits or the charcaters meillo@56: '.', '-', '_', '/', it must be quoted. Unfortunately, you meillo@56: cannot use quotes inside quotes. (Will be implemented in a later meillo@56: version.)

meillo@56: meillo@56:

Each val has a type, which can be boolean, numeric, string meillo@56: or list. A boolean variable can be set with one of the values 'on', meillo@56: 'yes', and 'true' or 'off', 'no' and 'false'. List items are separated meillo@56: with ';'. For some values patterns (like '*','?') can be used. The meillo@56: spaces before and after the '=' are optional.

meillo@56: meillo@56:

Most lists (exceptions: local_hosts, local_nets and meillo@56: listen_addresses) accept files. These will be recognized by a leading meillo@56: slash '/'. The contents of these files will be included at the meillo@56: position of the file name, there can be items or other files before meillo@56: and after the file entry. The format of the files is different meillo@56: though, within these files each entry is on another line. (And not meillo@56: separated by semicolons). This makes it easy to include large lists meillo@56: which are common in different configuration files, so they do not have meillo@56: to appear in every configuration file.

meillo@56: meillo@56:

Blank lines and lines starting with '#' are ignored.

meillo@56: meillo@56:

Main Configuration

meillo@56: meillo@56: run_as_user, Type: boolean, default: false meillo@56: meillo@56:

If this is set, masqmail runs with the user id of the user who meillo@56: invoked it and never changes it. This is for debugging purposes meillo@56: only. If the user is not root, masqmail will not be able to meillo@56: listen on a port < 1000 and will not be able to deliver local mail meillo@56: to others than the user.

meillo@56: meillo@56: use_syslog, Type: boolean, default: false meillo@56: meillo@56:

If this is set, masqmail uses syslogd for logging. It uses facility meillo@56: MAIL. You still have to set log_dir for debug files.

meillo@56: meillo@56: debug_level, Type: numeric, default: 0 meillo@56: meillo@56:

Set the debug level. Valid values are 0 to 6, increasing it further meillo@56: makes no difference. Be careful if you set this as high as 5 or higher, meillo@56: the logs may very soon fill your hard drive.

meillo@56: meillo@56: mail_dir, Type: string, default: none meillo@56: meillo@56:

The directory where local mail is stored, usually /var/spool/mail.

meillo@56: meillo@56: spool_dir, Type: string, default: none meillo@56: meillo@56:

The directory where masqmail stores its spool files (and later also meillo@56: other stuff). It must have a subdirectory meillo@56: input. Masqmail needs read and write permissions for this meillo@56: directory. I suggest to use /var/spool/masqmail.

meillo@56: meillo@56: log_dir, Type: string, default: none meillo@56: meillo@56:

The directory where masqmail puts its log files, these are meillo@56: masqmail.log and debug.log. Masqmail needs write meillo@56: permission.

meillo@56: meillo@56: host_name, Type: string, default: none meillo@56: meillo@56:

This is used in different places: Masqmail identifies itself in the meillo@56: greeting banner on incoming connections and in the HELO/EHLO command meillo@56: for outgoing connections with this name, it is used in the Received: meillo@56: header and to qualify the sender of a locally originating message.

meillo@56: meillo@56:

It is not used to find whether an address is local. Use meillo@56: local_hosts for that.

meillo@56: meillo@56: local_hosts, Type: list, default: none meillo@56: meillo@56:

A semicolon ';' separated list of hostnames which are considered meillo@56: local. Normally you set it to "localhost;foo;foo.bar.com" if your host meillo@56: has the fully qualified domain name 'foo.bar.com'.

meillo@56: meillo@56: local_nets, Type: list, default: none meillo@56: meillo@56:

A semicolon ';' separated list of hostnames which are on the meillo@56: 'local' net. Delivery to these hosts is attempted immediately. You can meillo@56: use patterns with '*', eg. "*.bar.com".

meillo@56: meillo@56: listen_addresses, Type: list, default: none meillo@56: meillo@56:

A semicolon ';' separated list of interfaces on which connections meillo@56: will be accepted. An interface ist defined by a hostname, optionally meillo@56: followed by a colon ':' and a number for the port. If this is left out, meillo@56: port 25 will be used.

meillo@56: meillo@56:

You can set this to "localhost:25;foo:25" if your hostname is 'foo'.

meillo@56: meillo@56: do_queue, Type: boolean, default: false meillo@56: meillo@56:

If this is set, mail will not be delivered immediately when meillo@56: accepted. Same as calling masqmail with the -odq option.

meillo@56: meillo@56: connect_route.<name>, Type: string, default: none meillo@56: meillo@56:

Replace <name> with a name to identify a connection. Set this meillo@56: to a filename for the special route configuration for that meillo@56: connection. You will use that name to call masqmail with the -qo option meillo@56: every time a connection to your ISP is set up.

meillo@56: meillo@56:

Example: Your ISP has the name FastNet. Then you write the meillo@56: following line in the main configuration:

meillo@56: meillo@56:

connect_route.FastNet = "/etc/masqmail/fastnet.route"

meillo@56: meillo@56:

/etc/masqmail/fastnet.route is the route configuration file, see meillo@56: below. As soon as a link to FastNet has been set up, you call masqmail meillo@56: -qoFastNet. Masqmail will then read the specified file and send the meillo@56: mails.

meillo@56: meillo@56: local_net_route, Type: string, default: none meillo@56: meillo@56:

This is similar to connect_route.<name> but for the meillo@56: local net. Recipient addresses that are in local_nets will be meillo@56: routed using this route configuration. Main purpose is to define a meillo@56: mail server with mail_host in your local network. In simple meillo@56: environments this can be left unset. If unset, a default route meillo@56: configuration will be used.

meillo@56: meillo@56: alias_file meillo@56: meillo@56:

Set this to the location of your alias file. If unset, no aliasing meillo@56: will be done.

meillo@56: meillo@56: online_detect, Type: string, default: none meillo@56: meillo@56:

Defines the method MasqMail uses to detect whether there is meillo@56: currently an online connection. It can have the values file meillo@56: or mserver.

meillo@56: meillo@56:

When it is set to file, MasqMail first checks for the meillo@56: existence of online_file (see below) and if it exists, it reads meillo@56: it. The content of the file should be the name of the current meillo@56: connection as defined with connect_route.<name> (without meillo@56: a trailing newline character).

meillo@56: meillo@56:

When it is set to mserver, MasqMail connects to the meillo@56: masqdialer server using the value of mserver_iface and asks it meillo@56: whether a connection exists and for the name, which should be the name meillo@56: of the current connection as defined with meillo@56: connect_route.<name>.

meillo@56: meillo@56:

The online status is checked either when masqmail receives a mail meillo@56: with an address outside your LAN or when called with the -qo option meillo@56: (without arguments).

meillo@56: meillo@56: online_file, Type: string, default: none meillo@56: meillo@56:

This is the name of the file checked for when MasqMail determines meillo@56: whether it is online. The file should only exist when there is meillo@56: currently a connection. Create it in your ip-up script with eg.

meillo@56: meillo@56:

meillo@56: echo -n <name> > /tmp/connect_route
meillo@56: chmod 0644 /tmp/connect_route
meillo@56: 

meillo@56: meillo@56:

Do not forget to delete it in your ip-down script.

meillo@56: meillo@56: mserver_iface, Type: string, default: none meillo@56: meillo@56:

The interface the masqdialer server is listening to. Usually this meillo@56: will be "localhost:224" if mserver is running on the same host as meillo@56: masqmail. But using this option, you can also let masqmail run on meillo@56: another host by setting mserver_iface to another hostname, meillo@56: eg. "foo:224".

meillo@56: meillo@56: get.<name>, Type: string, default: none meillo@56: meillo@56:

Replace <name> with a name to identify a get meillo@56: configuration. Set this to a filename for the get meillo@56: configuration. These files will be used to retrieve mail when called meillo@56: with the -g option.

meillo@56: meillo@56:

Route Configuration

meillo@56: meillo@56: mail_host, Type: string, default: none meillo@56: meillo@56:

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

meillo@56: meillo@56: do_correct_helo, Type: boolean, default: false meillo@56: meillo@56:

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

meillo@56: meillo@56: allowed_mail_locals, Type: list, default: none(all) meillo@56: meillo@56:

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

meillo@56: meillo@56: not_allowed_mail_locals, Type: list, default: none meillo@56: meillo@56:

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

meillo@56: meillo@56: allowed_rcpt_domains, Type: list, default: none(all) meillo@56: meillo@56:

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

meillo@56: meillo@56: not_allowed_rcpt_domains, Type: list, default: none meillo@56: meillo@56:

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

meillo@56: meillo@56: set_h_from_domain, Type: string, default: none meillo@56: meillo@56:

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

meillo@56: meillo@56: set_h_reply_to_domain, Type: string, default: none meillo@56: meillo@56:

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

meillo@56: meillo@56: set_return_path_domain, Type: string, default: none meillo@56: meillo@56:

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

meillo@56: meillo@56: map_h_from_addresses, Type: list, default: none meillo@56: meillo@56:

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

meillo@56: meillo@56:

Example:

meillo@56: meillo@56:

meillo@56: map_h_from_addresses =
meillo@56: "john: John Smith <jsmith@mail.academic.edu>;
meillo@56: charlie: Charlie Miller <cmiller@mx.commercial.com>"
meillo@56: 

meillo@56: meillo@56: map_h_reply_to_addresses, Type: list, default: none meillo@56: meillo@56:

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

meillo@56: meillo@56: map_return_path_addresses, Type: list, default: none meillo@56: meillo@56:

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

meillo@56: meillo@56:

Example:

meillo@56:

meillo@56: map_return_path_addresses =
meillo@56: "john: <jsmith@mail.academic.edu>;
meillo@56: charlie: <cmiller@mx.commercial.com>"
meillo@56: 

meillo@56: meillo@56: expand_h_sender_domain, Type: boolean, default: true meillo@56: meillo@56:

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

meillo@56: meillo@56: auth_name, Type: string, default: none meillo@56: meillo@56:

Set the authentication type for ESMTP AUTH authentification. meillo@56: Currently only 'cram-md5' is supported.

meillo@56: meillo@56: auth_login, Type: string, default: none meillo@56: meillo@56:

Your account name for ESMTP AUTH authentification.

meillo@56: meillo@56: auth_secret, Type: string, default: none meillo@56: meillo@56:

Your secret for ESMTP AUTH authentification.

meillo@56: meillo@56: pop_login, Type: string, default: none meillo@56: meillo@56:

If your Mail server requires SMTP-after-POP, set this to a meillo@56: get configuration. If you login to the POP server meillo@56: before you send, this is not necessary. See the get configuration for more information.

meillo@56: meillo@56:
meillo@56:

meillo@56:


meillo@56:
Oliver Kurth
meillo@56: Last modified: Tue May 30 15:19:56 CEST 2000 meillo@56:
meillo@56: This page was created using Genpage - Version: 1.0.6 meillo@56:

meillo@56: meillo@56:
meillo@56:
meillo@56: meillo@56: meillo@56: meillo@56: