meillo@1: meillo@1:

masqmail

meillo@1:

An offline Mail Transfer Agent

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

Synopsis

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

Description

meillo@1: meillo@1:

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

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

Options

meillo@1: meillo@1:

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

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

meillo@1:

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

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

-bd

meillo@1:

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

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

-bi

meillo@1:

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

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

-bp

meillo@1:

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

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

-bs

meillo@1:

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

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

-B arg

meillo@1:

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

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

-bV

meillo@1:

Show version information.

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

-C filename

meillo@1:

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

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

-d number

meillo@1: meillo@1:

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

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

-f [address]

meillo@1: meillo@1:

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

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

-F [string]

meillo@1: meillo@1:

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

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

-g [name]

meillo@1: meillo@1:

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

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

-go [interval] [name]

meillo@1: meillo@1:

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

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

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

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

-i

meillo@1:

Same as -oi, see below.

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

-Mrm list

meillo@1:

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

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

-oem

meillo@1:

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

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

-odb

meillo@1:

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

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

-odq

meillo@1:

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

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

-oi

meillo@1:

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

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

-q [interval]

meillo@1:

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

meillo@1:

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

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

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

-qo [name]

meillo@1: meillo@1:

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

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

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

-t

meillo@1:

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

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

-v

meillo@1:

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

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

Environment for pipes and mdas

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

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

meillo@1:

SENDER, RETURN_PATH - the return path.

meillo@1:

SENDER_DOMAIN - the domain part of the return path.

meillo@1:

SENDER_LOCAL - the local part of the return path.

meillo@1:

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

meillo@1:

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

meillo@1:

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

meillo@1:

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

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

Files

meillo@1: meillo@1:

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

meillo@1:

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

meillo@1:

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

meillo@1:

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

meillo@1:

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

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

Conforming to

meillo@1: meillo@1:

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

meillo@1:

RFC 1725, 1939 (POP3)

meillo@1:

RFC 1321 (MD5)

meillo@1:

RFC 2195 (CRAM-MD5)

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:

Comments

meillo@1: meillo@1:

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

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

meillo@1: