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

The configuration consists of lines of the form

meillo@1: meillo@1: val = expression meillo@1: meillo@1:

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

meillo@1: meillo@1:

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

meillo@1: meillo@1:

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

meillo@1: meillo@1:

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

meillo@1: meillo@1:

Main Configuration

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

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

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

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

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

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

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

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

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

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

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

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

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

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

meillo@1: meillo@1:

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

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

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

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

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

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

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

meillo@1: meillo@1:

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

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

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

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

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

meillo@1: meillo@1:

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

meillo@1: meillo@1:

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

meillo@1: meillo@1:

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

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

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

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

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

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

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

meillo@1: meillo@1:

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

meillo@1: meillo@1:

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

meillo@1: meillo@1:

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

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

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

meillo@1: meillo@1:

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

meillo@1: meillo@1:

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

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

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

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

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

meillo@1: meillo@1:

Route Configuration

meillo@1: meillo@1: mail_host, Type: string, default: none 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: meillo@1: do_correct_helo, Type: boolean, default: false 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 will be used.

meillo@1: meillo@1: allowed_mail_locals, Type: list, default: none(all) 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 and meillo@1: not_allowed_mail_locals is also unset, all users are meillo@1: allowed.

meillo@1: meillo@1: not_allowed_mail_locals, Type: list, default: none 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: allowed_rcpt_domains, Type: list, default: none(all) 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: not_allowed_rcpt_domains, Type: list, default: none 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 meillo@1: ist not set) and you know of hosts that will not accept mail from you meillo@1: because they use a dialup list (eg. maps.vix.com/dul/). If any domain meillo@1: matches both allowed_rcpt_domains and meillo@1: not_allowed_rcpt_domains, mail will not be sent to meillo@1: this domain. Patterns containing '?' and '*' can be used.

meillo@1: meillo@1: set_h_from_domain, Type: string, default: none 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: set_h_reply_to_domain, Type: string, default: none meillo@1: meillo@1:

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

meillo@1: meillo@1: set_return_path_domain, Type: string, default: none 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: map_h_from_addresses, Type: list, default: none 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:

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

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

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

meillo@1: meillo@1: map_return_path_addresses, Type: list, default: none 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: <jsmith@mail.academic.edu>;
meillo@1: charlie: <cmiller@mx.commercial.com>"
meillo@1: 

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

This sets the domain of the sender address as given by the Sender: meillo@1: header to the same domain as in the envelope return path address meillo@1: (which can be set by either set_return_path_domain or meillo@1: map_return_path_addresses). This is for mail clients meillo@1: (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.

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

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

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

Your account name for ESMTP AUTH authentification.

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

Your secret for ESMTP AUTH authentification.

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

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

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

meillo@1:


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

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