view man/masqmail.aliases.5 @ 434:f2a7271746d1 default tip

Removes Freshmeat.net from the docs The site, which was later renamed to freecode.com, is no longer maintained (contains only a static copy).
author markus schnalke <meillo@marmaro.de>
date Sat, 07 Feb 2015 11:45:07 +0100
parents 34c919a8d74e
children
line wrap: on
line source

.TH masqmail.aliases 5 2015-02-07 masqmail-0.3.5 "File Formats"

.SH NAME
masqmail.aliases \- masqmail alias file format


.SH DESCRIPTION

This man page describes the format of the masqmail alias file.
It's usual location is \fI/etc/aliases\fR.

There exists also a variant of this format for glob patterns.
It's used with the \fIglobalias_file\fP config option.

The difference between the two formats are only on the left-hand side.
A normal alias file has a local_part there that gets string-compared
against the local part;
whereas a glob alias file has a glob pattern that is matched against
the whole address. The right-hand side of the two aliasing kinds
has the same format.


.SH FILE FORMAT

Normal alias files consist of lines of the form:

.RS
local_part: item1, item2, ...
.RE

Glob-pattern alias files consist of lines of the form:

.RS
glob_pattern: item1, item2, ...
.RE

Items can be surrounded by double quotes `"'.
If within the quotes other quotes are needed for an address they can be
escaped with a leading backslash `\\'.

A leading backslash `\\' indicates that this address shall not be
further expanded.

A leading pipe symbol `|' indicates that the item shall be treated as a
pipe command.
The content of the message will then be sent to the standard input of the
command.
The command will run under the user id and group id masqmail is running as.
If quotes are needed, the pipe symbol must appear within the quotes.

Loops will be detected, the offending address will be ignored.

Aliases will be expanded at delivery time.
This means that if there is a message still in the queue and you change
any alias which matches one of the recipient addresses,
the change will have effect next time a delivery is attemped.

There is no need to restart masqmail or run any command when the alias
file has been changed. (`masqmail -bi' is a no-op.)


.SH EXAMPLE

A normal alias file:

.RS
.nf
# postmaster is required by RFC 2821
postmaster: root

# forward abuse mail to another address
abuse: abuse@example.org

# copy root's mail also to meillo
root: \\root, meillo

# pass mail to a script
foo: |/usr/bin/foo
.fi
.RE


A glob-pattern alias file:

.RS
.nf
# the postmaster for any domain on this host
postmaster@*: ken

# split virtual domains
info@foo.example.org: doug
info@bar.example.org: rob

# the order of entries is important
# this must be before the catch-all line
list\-*@example.org: |/path/to/some/script

# catch-all address forwarded to extern
*@example.org: brian@other.host.net
.fi
.RE


.SH AUTHOR

Masqmail was written by Oliver Kurth.
It is now maintained by Markus Schnalke <meillo@marmaro.de>.

You will find the newest version of masqmail at
\fBhttp://marmaro.de/prog/masqmail/\fR.
There is also a mailing list, you will find information about
it at masqmail's main site.


.SH BUGS

Please report bugs to the mailing list.


.SH SEE ALSO

\fBmasqmail.conf(5)\fR, \fBmasqmail(8)\fR,