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