meillo@56: meillo@56:

masqmail

meillo@56:

An offline Mail Transfer Agent

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

Synopsis

meillo@56: meillo@56: /usr/sbin/masqmail [-C file] [-odq] [-bd] [-qinterval]
meillo@56: meillo@56: /usr/sbin/masqmail [-odq] [-bs]
meillo@56: meillo@56: /usr/sbin/masqmail [-bp]
meillo@56: meillo@56: /usr/sbin/masqmail [-q]
meillo@56: meillo@56: /usr/sbin/masqmail [-qo [name]]
meillo@56: meillo@56: /usr/sbin/masqmail [-odq] [-g [name]]
meillo@56: meillo@56: /usr/sbin/masqmail [-odq] [-go [name]]
meillo@56: meillo@56: /usr/sbin/masqmail [-t] [-oi] [-f address] [--] address...
meillo@56: meillo@56: /usr/sbin/mailq
meillo@56: meillo@56: meillo@56: meillo@56: meillo@56:

Description

meillo@56: meillo@56:

MasqMail is a mail server designed for hosts that do meillo@56: not have a permanent internet connection eg. a home network or a meillo@56: single host at home. It has special support for connections to meillo@56: different ISPs. It replaces sendmail or other MTAs such as qmail or meillo@56: exim. It can also act as a pop3 client.

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

Options

meillo@56: meillo@56:

Since masqmail is intended to replace sendmail, it uses the same meillo@56: command line options, but not all are implemented. There are also two meillo@56: additional options, which are unique to masqmail (-qo connection and -g) meillo@56:

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

meillo@56:

Not a 'real' option, it means that all following arguments are to meillo@56: be understood as arguments and not as options even if they begin with a meillo@56: leading dash '-'. Mutt is known to call sendmail with this option.

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

-bd

meillo@56:

Run as daemon, accepting connections, usually on port 25 if not meillo@56: configured differently. This is usually used in the startup script at system boot and meillo@56: together with the -q option (see below).

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

-bi

meillo@56:

Old sendmail rebuilds its alias database when invoked with this meillo@56: option. Masqmail ignores it. Masqmail reads directly from the file meillo@56: given with alias_file in the config file.

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

-bp

meillo@56:

Show the messages in the queue. Same as calling masqmail as meillo@56: 'mailq'.

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

-bs

meillo@56:

Accept SMTP commands from stdin. Some mailers (eg pine) use this meillo@56: option as an interface. It can also be used to call masqmail from meillo@56: inetd.

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

-B arg

meillo@56:

arg is usually 8BITMIME. Some mailers use this meillo@56: to indicate that the message contains characters > 127. Masqmail is meillo@56: 8-bit clean and ignores this, so you do not have to recompile elm, meillo@56: which is very painful ;-). Note though that this violates some meillo@56: conventions: masqmail does not convert 8 bit messages to any meillo@56: MIME format if it encounters a mail server which does not advertise meillo@56: its 8BITMIME capability, masqmail does not advertise this itself. This meillo@56: is the same practice as that of exim (but different to meillo@56: sendmail).

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

-bV

meillo@56:

Show version information.

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

-C filename

meillo@56:

Use another configuration than /etc/masqmail/masqmail.conf. Useful for meillo@56: debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges. meillo@56:

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

-d number

meillo@56: meillo@56:

Set the debug level. This takes precedence before the value of meillo@56: debug_level in the configuration file. Read the warning in the meillo@56: description of the latter. meillo@56:

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

-f [address]

meillo@56: meillo@56:

Set the return path address to address. Only root, the meillo@56: user mail and anyoune in group trusted is allowed to do that.

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

-F [string]

meillo@56: meillo@56:

Set the full sender name (in the From: header) meillo@56: to string.

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

-g [name]

meillo@56: meillo@56:

Get mail (using pop3 or apop), using the configurations given meillo@56: with get.name in the main configuration. Without name, meillo@56: all get configurations will be used. See also masqmail.get

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

-go [interval] [name]

meillo@56: meillo@56:

Can be followed by a connection name. Use this option in your meillo@56: script which starts as soon as a link to the internet has been set up meillo@56: (usually ip-up). When masqmail is called with this option, the meillo@56: specified get configuration(s) is(are) read and mail will be meillo@56: retrieved from servers on the internet. meillo@56: The name is defined meillo@56: in the configuration (see online_gets.name). meillo@56:

meillo@56: If called with an interval option (recognized by a digit meillo@56: as the first characater), masqmail starts as a daemon and tries to meillo@56: get mail in these intervals. It checks for the online status first. meillo@56: Example: masqmail -go 5m will retrieve mail meillo@56: all five minutes. meillo@56:

meillo@56: If called without name the online status is determined with meillo@56: the configured method (see online_detect in config.html). meillo@56:

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

-i

meillo@56:

Same as -oi, see below.

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

-Mrm list

meillo@56:

Remove given messages from the queue. Only allowed for privileged users.

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

-oem

meillo@56:

If the -oi ist not also given, always return with a non zero meillo@56: return code. Maybe someone tells me what this is good for...

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

-odb

meillo@56:

Deliver in background. Masqmail always does this, which meillo@56: makes this option pretty much useless.

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

-odq

meillo@56:

Do not attempt to deliver immediately. Any messages will be queued meillo@56: until the next queue running process picks them up and delivers meillo@56: them. You get the same effect by setting the do_queue option in meillo@56: /etc/masqmail/masqmail.conf.

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

-oi

meillo@56:

A dot as a single character in a line does not terminate meillo@56: the message.

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

-q [interval]

meillo@56:

If not given with an argument, run a queue process, ie. try to meillo@56: deliver all messages in the queue. Masqmail sends only to those meillo@56: addresses that are on the local net, not to those that are meillo@56: outside. Use -qo for those.

meillo@56:

meillo@56: If you have configured inetd to start masqmail, you can use this meillo@56: option in a cron job which starts in regular time intervals, to mimic meillo@56: the same effect as starting masqmail with -bd -q30m. meillo@56:

meillo@56: An argument may be a time interval ie. a numerical value followed meillo@56: by one of the letters. s,m,h,d,w which are interpreted as seconds, meillo@56: minutes, hours, days or weeks respectively. Example: -q30m. Masqmail meillo@56: starts as a daemon and a queue runner process will be started meillo@56: automatically once in this time interval. This is usually used meillo@56: together with -bd (see above). meillo@56:

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

-qo [name]

meillo@56: meillo@56:

Can be followed by a connection name. Use this option in your meillo@56: script which starts as soon as a link to the internet has been set up meillo@56: (usually ip-up). When masqmail is called with this option, the meillo@56: specified route configuration is read and the queued mail with meillo@56: destinations on the internet will be sent. The name is defined meillo@56: in the configuration (see online_routes.name). meillo@56:

meillo@56: If called without name the online status is determined with meillo@56: the configured method (see online_detect in config.html) meillo@56:

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

-t

meillo@56:

Read recipients from headers. Delete 'Bcc:' headers. If any meillo@56: arguments are given, these are interpreted as recipient addresses and meillo@56: the message will not be sent to these.

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

-v

meillo@56:

Log also to stdout. Currently, some log messages are meillo@56: marked as 'write to stdout' and additionally, all messages with meillo@56: priority 'LOG_ALERT' and 'LOG_WARNING' will be written to stdout meillo@56: if this option is given. It is disabled in daemon mode. meillo@56:

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

Environment for pipes and mdas

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

For security reasons, before any pipe command from an alias meillo@56: expansion or an mda is called, the environment variables will be meillo@56: completely discarded and newly set up. These are:

meillo@56:

SENDER, RETURN_PATH - the return path.

meillo@56:

SENDER_DOMAIN - the domain part of the return path.

meillo@56:

SENDER_LOCAL - the local part of the return path.

meillo@56:

RECEIVED_HOST - the host the message was received from (unless local).

meillo@56:

LOCAL_PART, USER, LOGNAME - the local part of the (original) recipient.

meillo@56:

MESSAGE_ID - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.

meillo@56:

QUALIFY_DOMAIN - the domain which will be appended to unqualified addresses.

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

Files

meillo@56: meillo@56:

/etc/masqmail/masqmail.conf is the main configuration meillo@56: for masqmail. Depending on the settings in this file, you will also meillo@56: have other configuration files in /etc/masqmail/.

meillo@56:

/etc/aliases is the alias file, if not set differently meillo@56: in /etc/masqmail/masqmail.conf.

meillo@56:

/var/spool/masqmail/ is the spool directory where masqmail meillo@56: stores its spooled messages and the uniq pop ids.

meillo@56:

/var/spool/mail/ is the directory where locally delivered mail will be put, if not configured differently in masqmail.conf.

meillo@56:

/var/log/masqmail/ is the directory where masqmail stores meillo@56: its log mesages. This can also be somewhere else if configured meillo@56: differently by your sysadmin or the package mantainer.

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

Conforming to

meillo@56: meillo@56:

RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)

meillo@56:

RFC 1725, 1939 (POP3)

meillo@56:

RFC 1321 (MD5)

meillo@56:

RFC 2195 (CRAM-MD5)

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

Author

meillo@56: meillo@56:

masqmail was written by Oliver Kurth meillo@56:

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

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

Bugs

meillo@56: meillo@56:

You should report them to the mailing list.

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

Comments

meillo@56: meillo@56:

This man page was written using xml2man by the same author.

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

meillo@56: