external/ibm-public/postfix/dist/man/man5/aliases.5

   1 .\"     $NetBSD$
   2 .\"
   3 .TH ALIASES 5
   4 .ad
   5 .fi
   6 .SH NAME
   7 aliases
   8 \-
   9 Postfix local alias database format
  10 .SH "SYNOPSIS"
  11 .na
  12 .nf
  13 .fi
  14 \fBnewaliases\fR
  15 .SH DESCRIPTION
  16 .ad
  17 .fi
  18 The \fBaliases\fR(5) table provides a system-wide mechanism to
  19 redirect mail for local recipients. The redirections are
  20 processed by the Postfix \fBlocal\fR(8) delivery agent.
  21
  22 Normally, the \fBaliases\fR(5) table is specified as a text file
  23 that serves as input to the \fBpostalias\fR(1) command. The
  24 result, an indexed file in \fBdbm\fR or \fBdb\fR format, is
  25 used for fast lookup by the mail system. Execute the command
  26 \fBnewaliases\fR in order to rebuild the indexed file after
  27 changing the Postfix alias database.
  28
  29 The input and output file formats are expected to be compatible
  30 with Sendmail version 8, and are expected to be suitable for the
  31 use as NIS maps.
  32
  33 Users can control delivery of their own mail by setting
  34 up \fB.forward\fR files in their home directory.
  35 Lines in per-user \fB.forward\fR files have the same syntax
  36 as the right-hand side of \fBaliases\fR(5) entries.
  37
  38 The format of the alias database input file is as follows:
  39 .IP \(bu
  40 An alias definition has the form
  41 .sp
  42 .nf
  43      \fIname\fR: \fIvalue1\fR, \fIvalue2\fR, \fI...\fR
  44 .fi
  45 .IP \(bu
  46 Empty lines and whitespace-only lines are ignored, as
  47 are lines whose first non-whitespace character is a `#'.
  48 .IP \(bu
  49 A logical line starts with non-whitespace text. A line that
  50 starts with whitespace continues a logical line.
  51 .PP
  52 The \fIname\fR is a local address (no domain part).
  53 Use double quotes when the name contains any special characters
  54 such as whitespace, `#', `:', or `@'. The \fIname\fR is folded to
  55 lowercase, in order to make database lookups case insensitive.
  56 .PP
  57 In addition, when an alias exists for \fBowner-\fIname\fR, delivery
  58 diagnostics are directed to that address, instead of to the originator
  59 of the message.
  60 This is typically used to direct delivery errors to the maintainer of
  61 a mailing list, who is in a better position to deal with mailing
  62 list delivery problems than the originator of the undelivered mail.
  63 .PP
  64 The \fIvalue\fR contains one or more of the following:
  65 .IP \fIaddress\fR
  66 Mail is forwarded to \fIaddress\fR, which is compatible
  67 with the RFC 822 standard.
  68 .IP \fI/file/name\fR
  69 Mail is appended to \fI/file/name\fR. See \fBlocal\fR(8)
  70 for details of delivery to file.
  71 Delivery is not limited to regular files.  For example, to dispose
  72 of unwanted mail, deflect it to \fB/dev/null\fR.
  73 .IP "|\fIcommand\fR"
  74 Mail is piped into \fIcommand\fR. Commands that contain special
  75 characters, such as whitespace, should be enclosed between double
  76 quotes. See \fBlocal\fR(8) for details of delivery to command.
  77 .sp
  78 When the command fails, a limited amount of command output is
  79 mailed back to the sender.  The file \fB/usr/include/sysexits.h\fR
  80 defines the expected exit status codes. For example, use
  81 \fB"|exit 67"\fR to simulate a "user unknown" error, and
  82 \fB"|exit 0"\fR to implement an expensive black hole.
  83 .IP \fB:include:\fI/file/name\fR
  84 Mail is sent to the destinations listed in the named file.
  85 Lines in \fB:include:\fR files have the same syntax
  86 as the right-hand side of alias entries.
  87 .sp
  88 A destination can be any destination that is described in this
  89 manual page. However, delivery to "|\fIcommand\fR" and
  90 \fI/file/name\fR is disallowed by default. To enable, edit the
  91 \fBallow_mail_to_commands\fR and \fBallow_mail_to_files\fR
  92 configuration parameters.
  93 .SH "ADDRESS EXTENSION"
  94 .na
  95 .nf
  96 .ad
  97 .fi
  98 When alias database search fails, and the recipient localpart
  99 contains the optional recipient delimiter (e.g., \fIuser+foo\fR),
 100 the search is repeated for the unextended address (e.g., \fIuser\fR).
 101
 102 The \fBpropagate_unmatched_extensions\fR parameter controls
 103 whether an unmatched address extension (\fI+foo\fR) is
 104 propagated to the result of table lookup.
 105 .SH "CASE FOLDING"
 106 .na
 107 .nf
 108 .ad
 109 .fi
 110 The local(8) delivery agent always folds the search string
 111 to lowercase before database lookup.
 112 .SH "SECURITY"
 113 .na
 114 .nf
 115 .ad
 116 .fi
 117 The \fBlocal\fR(8) delivery agent disallows regular expression
 118 substitution of $1 etc. in \fBalias_maps\fR, because that
 119 would open a security hole.
 120
 121 The \fBlocal\fR(8) delivery agent will silently ignore
 122 requests to use the \fBproxymap\fR(8) server within
 123 \fBalias_maps\fR. Instead it will open the table directly.
 124 Before Postfix version 2.2, the \fBlocal\fR(8) delivery
 125 agent will terminate with a fatal error.
 126 .SH "CONFIGURATION PARAMETERS"
 127 .na
 128 .nf
 129 .ad
 130 .fi
 131 The following \fBmain.cf\fR parameters are especially relevant.
 132 The text below provides only a parameter summary. See
 133 \fBpostconf\fR(5) for more details including examples.
 134 .IP \fBalias_database\fR
 135 List of alias databases that are updated by the
 136 \fBnewaliases\fR(1) command.
 137 .IP \fBalias_maps\fR
 138 List of alias databases queried by the \fBlocal\fR(8) delivery agent.
 139 .IP \fBallow_mail_to_commands\fR
 140 Restrict the usage of mail delivery to external command.
 141 .IP \fBallow_mail_to_files\fR
 142 Restrict the usage of mail delivery to external file.
 143 .IP \fBexpand_owner_alias\fR
 144 When delivering to an alias that has an \fBowner-\fR companion alias,
 145 set the envelope sender address to the right-hand side of the
 146 owner alias, instead using of the left-hand side address.
 147 .IP \fBpropagate_unmatched_extensions\fR
 148 A list of address rewriting or forwarding mechanisms that
 149 propagate an address extension from the original address
 150 to the result. Specify zero or more of \fBcanonical\fR,
 151 \fBvirtual\fR, \fBalias\fR, \fBforward\fR, \fBinclude\fR,
 152 or \fBgeneric\fR.
 153 .IP \fBowner_request_special\fR
 154 Give special treatment to \fBowner-\fIlistname\fR and
 155 \fIlistname\fB-request\fR
 156 addresses.
 157 .IP \fBrecipient_delimiter\fR
 158 Delimiter that separates recipients from address extensions.
 159 .PP
 160 Available in Postfix version 2.3 and later:
 161 .IP \fBfrozen_delivered_to\fR
 162 Update the local(8) delivery agent's Delivered-To: address
 163 (see prepend_delivered_header) only once, at the start of
 164 a delivery; do not update the Delivered-To: address while
 165 expanding aliases or .forward files.
 166 .SH "STANDARDS"
 167 .na
 168 .nf
 169 RFC 822 (ARPA Internet Text Messages)
 170 .SH "SEE ALSO"
 171 .na
 172 .nf
 173 local(8), local delivery agent
 174 newaliases(1), create/update alias database
 175 postalias(1), create/update alias database
 176 postconf(5), configuration parameters
 177 .SH "README FILES"
 178 .na
 179 .nf
 180 .ad
 181 .fi
 182 Use "\fBpostconf readme_directory\fR" or
 183 "\fBpostconf html_directory\fR" to locate this information.
 184 .na
 185 .nf
 186 DATABASE_README, Postfix lookup table overview
 187 .SH "LICENSE"
 188 .na
 189 .nf
 190 .ad
 191 .fi
 192 The Secure Mailer license must be distributed with this software.
 193 .SH "AUTHOR(S)"
 194 .na
 195 .nf
 196 Wietse Venema
 197 IBM T.J. Watson Research
 198 P.O. Box 704
 199 Yorktown Heights, NY 10598, USA