.TH ALIASES 5 "$Mdocdate: February 4 2014 $" ""
.SH NAME
.ad l
\fB\%aliases\fP
\- aliases file for smtpd
.SH SYNOPSIS
.ad l
.br
\fB\%aliases\fP
.SH DESCRIPTION
.ad l
This manual page describes the format of the
\fB\%aliases\fP
file, as used by
\fBsmtpd\fP(8).
An alias in its simplest form is used to assign an arbitrary name
to an email address, or a group of email addresses.
This provides a convenient way to send mail.
For example an alias could refer to all users of a group:
email to that alias would be sent to all members of the group.
Much more complex aliases can be defined however:
an alias can refer to other aliases,
be used to send mail to a file instead of another person,
or to execute various commands.
.PP
Within the file,
Ql #
is a comment delimiter; anything placed after it is discarded.
The file consists of key/value mappings of the form:
-filled -offset indent
key: value1, value2, value3, ...
.RE
.PP
.IR key
is always folded to lowercase before alias lookups to ensure that
there can be no ambiguity.
The key is expanded to the corresponding values,
which consist of one or more of the following:
.RS 5
.TP
.IR user
A user on the host machine.
The user must have a valid entry in the
\fBpasswd\fP(5)
database file.
.TP
\fI/path/to/file\fP
Append messages to
\fIfile\fP,
specified by its absolute pathname.
.TP
| \fIcommand\fP
Pipe the message to
\fIcommand\fP
on its standard input.
The command is run under the privileges of the daemon's unprivileged account.
.TP
: \fIinclude\fP: \fI/path/to/file\fP
Include any definitions in
\fIfile\fP
as alias entries.
The format of the file is identical to this one.
.TP
\fIuser-part@domain-part\fP
An email address in RFC 5322 format
(see
\fBmailaddr\fP(7)).
If an address extension is appended to the user-part,
it is stripped so that an address such as user+ext@example.com
will only use the part that precedes
Sq +
as a
.IR key.
.TP
\fIerror\fP: \fIcode\fP \fImessage\fP
A status code and message to return.
The code must be 3 digits,
starting 4XX (TempFail) or 5XX (PermFail).
The message must be present and can be freely chosen.
.TP
\fImaildir:/path\fP
Deliver messages to Maildir at the
\fIpath.\fP
.RE
.SH FILES
.ad l
.RS 5
.TP
.B /etc/aliases
Default
\fB\%aliases\fP
file.
.RE
.SH SEE ALSO
.ad l
\fBsmtpd.conf\fP(5),
\fBmakemap\fP(8),
\fBnewaliases\fP(8),
\fBsmtpd\fP(8)
.SH HISTORY
.ad l
The
\fB\%aliases\fP
file format appeared in
Bx 4.0.