1ALIASES(5)                    File Formats Manual                   ALIASES(5)
2
3
4

NAME

6       aliases - aliases file for smtpd
7

DESCRIPTION

9       This manual page describes the format of the aliases file, as used by
10       smtpd(8).  An alias in its simplest form is used to assign an arbitrary
11       name to an email address, or a group of email addresses.  This provides
12       a convenient way to send mail.  For example an alias could refer to all
13       users of a group: email to that alias would be sent to all members of
14       the group.  Much more complex aliases can be defined however: an alias
15       can refer to other aliases, be used to send mail to a file instead of
16       another person, or to execute various commands.
17
18       Within the file, Ql # is a comment delimiter; anything placed after it
19       is discarded.  The file consists of key/value mappings of the form:
20       -filled -offset indent key: value1, value2, value3, ...
21
22       key is always folded to lowercase before alias lookups to ensure that
23       there can be no ambiguity.  The key is expanded to the corresponding
24       values, which consist of one or more of the following:
25
26            user   A user on the host machine.  The user must have a valid
27                   entry in the passwd(5) database file.
28
29            /path/to/file
30                   Append messages to file, specified by its absolute path‐
31                   name.
32
33            | command
34                   Pipe the message to command on its standard input.  The
35                   command is run under the privileges of the daemon's unpriv‐
36                   ileged account.
37
38            : include: /path/to/file
39                   Include any definitions in file as alias entries.  The for‐
40                   mat of the file is identical to this one.
41
42            user-part@domain-part
43                   An email address in RFC 5322 format.  If an address exten‐
44                   sion is appended to the user-part, it is first compared for
45                   an exact match.  It is then stripped so that an address
46                   such as user+ext@example.com will only use the part that
47                   precedes Sq + as a key.
48
49            error: code message
50                   A status code and message to return.  The code must be 3
51                   digits, starting 4XX (TempFail) or 5XX (PermFail).  The
52                   message must be present and can be freely chosen.
53

FILES

55            /etc/opensmtpd/aliases
56                   Default aliases file.
57

SEE ALSO

59       smtpd.conf(5), makemap(8), newaliases(8), smtpd(8)
60

HISTORY

62       The aliases file format appeared in Bx 4.0.
63
64
65
66                          $Mdocdate: April 23 2020 $                ALIASES(5)
Impressum