~ubuntu-branches/ubuntu/hoary/postfix/hoary-security

« back to all changes in this revision

Viewing changes to proto/virtual

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2004-10-06 11:50:33 UTC
  • Revision ID: james.westby@ubuntu.com-20041006115033-ooo6yfg6kmoteu04
Tags: upstream-2.1.3
ImportĀ upstreamĀ versionĀ 2.1.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#++
 
2
# NAME
 
3
#       virtual 5
 
4
# SUMMARY
 
5
#       format of Postfix virtual alias table
 
6
# SYNOPSIS
 
7
#       \fBpostmap /etc/postfix/virtual\fR
 
8
#
 
9
#       \fBpostmap -q "\fIstring\fB" /etc/postfix/virtual\fR
 
10
#
 
11
#       \fBpostmap -q - /etc/postfix/virtual <\fIinputfile\fR
 
12
# DESCRIPTION
 
13
#       The optional \fBvirtual\fR alias table specifies address aliasing
 
14
#       for arbitrary local or non-local recipient addresses. Virtual aliasing
 
15
#       is recursive, and is done by the Postfix \fBcleanup\fR(8) daemon.
 
16
#
 
17
#       The main applications of virtual aliasing are:
 
18
# .IP \(bu
 
19
#       To redirect mail for one address to one or more addresses.
 
20
# .IP \(bu
 
21
#       To implement virtual alias domains where all addresses are aliased
 
22
#       to addresses in other domains.
 
23
# .sp
 
24
#       Virtual alias domains are not to be confused with the virtual mailbox
 
25
#       domains that are implemented with the Postfix \fBvirtual\fR(8) mail
 
26
#       delivery agent. With virtual mailbox domains, each recipient address
 
27
#       can have its own mailbox.
 
28
# .PP
 
29
#       Virtual aliasing is applied only to recipient
 
30
#       envelope addresses, and does not affect message headers.
 
31
#       Think Sendmail rule set \fBS0\fR, if you like. Use \fBcanonical\fR(5)
 
32
#       mapping to rewrite header and envelope addresses in general.
 
33
#
 
34
#       Normally, the \fBvirtual\fR alias table is specified as a text file
 
35
#       that serves as input to the \fBpostmap\fR(1) command.
 
36
#       The result, an indexed file in \fBdbm\fR or \fBdb\fR format,
 
37
#       is used for fast searching by the mail system. Execute the command
 
38
#       \fBpostmap /etc/postfix/virtual\fR in order to rebuild the indexed
 
39
#       file after changing the text file.
 
40
#
 
41
#       When the table is provided via other means such as NIS, LDAP
 
42
#       or SQL, the same lookups are done as for ordinary indexed files.
 
43
#
 
44
#       Alternatively, the table can be provided as a regular-expression
 
45
#       map where patterns are given as regular expressions, or lookups
 
46
#       can be directed to TCP-based server. In that case, the lookups are
 
47
#       done in a slightly different way as described below under
 
48
#       "REGULAR EXPRESSION TABLES" and "TCP-BASED TABLES".
 
49
# TABLE FORMAT
 
50
# .ad
 
51
# .fi
 
52
#       The input format for the \fBpostmap\fR(1) command is as follows:
 
53
# .IP "\fIpattern result\fR"
 
54
#       When \fIpattern\fR matches a mail address, replace it by the
 
55
#       corresponding \fIresult\fR.
 
56
# .IP "blank lines and comments"
 
57
#       Empty lines and whitespace-only lines are ignored, as
 
58
#       are lines whose first non-whitespace character is a `#'.
 
59
# .IP "multi-line text"
 
60
#       A logical line starts with non-whitespace text. A line that
 
61
#       starts with whitespace continues a logical line.
 
62
# .PP
 
63
#       With lookups from indexed files such as DB or DBM, or from networked
 
64
#       tables such as NIS, LDAP or SQL, patterns are tried in the order as
 
65
#       listed below:
 
66
# .IP "\fIuser\fR@\fIdomain address, address, ...\fR"
 
67
#       Mail for \fIuser\fR@\fIdomain\fR is redirected to \fIaddress\fR.
 
68
#       This form has the highest precedence.
 
69
# .IP "\fIuser address, address, ...\fR"
 
70
#       Mail for \fIuser\fR@\fIsite\fR is redirected to \fIaddress\fR when
 
71
#       \fIsite\fR is equal to $\fBmyorigin\fR, when \fIsite\fR is listed in
 
72
#       $\fBmydestination\fR, or when it is listed in $\fBinet_interfaces\fR
 
73
#       or $\fBproxy_interfaces\fR.
 
74
#       .sp
 
75
#       This functionality overlaps with functionality of the local
 
76
#       \fIaliases\fR(5) database. The difference is that \fBvirtual\fR
 
77
#       mapping can be applied to non-local addresses.
 
78
# .IP "@\fIdomain address, address, ...\fR"
 
79
#       Mail for any user in \fIdomain\fR is redirected to \fIaddress\fR.
 
80
#       This form has the lowest precedence.
 
81
# .PP
 
82
#       In all the above forms, when \fIaddress\fR has the form
 
83
#       @\fIotherdomain\fR, the result is the same user in \fIotherdomain\fR.
 
84
#       This works for the first address in the expansion only.
 
85
# ADDRESS EXTENSION
 
86
# .fi
 
87
# .ad
 
88
#       When a mail address localpart contains the optional recipient delimiter
 
89
#       (e.g., \fIuser+foo\fR@\fIdomain\fR), the lookup order becomes:
 
90
#       \fIuser+foo\fR@\fIdomain\fR, \fIuser\fR@\fIdomain\fR, \fIuser+foo\fR,
 
91
#       \fIuser\fR, and @\fIdomain\fR.
 
92
#
 
93
#       The \fBpropagate_unmatched_extensions\fR parameter controls whether
 
94
#       an unmatched address extension (\fI+foo\fR) is propagated to the
 
95
#       result of table lookup.
 
96
# VIRTUAL ALIAS DOMAINS
 
97
# .ad
 
98
# .fi
 
99
#       Besides virtual aliases, the virtual alias table can also be used
 
100
#       to implement virtual alias domains. With a virtual alias domain, all
 
101
#       recipient addresses are aliased to addresses in other domains.
 
102
#
 
103
#       Virtual alias domains are not to be confused with the virtual mailbox
 
104
#       domains that are implemented with the Postfix \fBvirtual\fR(8) mail
 
105
#       delivery agent. With virtual mailbox domains, each recipient address
 
106
#       can have its own mailbox.
 
107
#
 
108
#       With a virtual alias domain, the virtual domain has its
 
109
#       own user name space. Local (i.e. non-virtual) usernames are not
 
110
#       visible in a virtual alias domain. In particular, local
 
111
#       \fBaliases\fR(5) and local mailing lists are not visible as
 
112
#       \fIlocalname@virtual-alias.domain\fR.
 
113
#
 
114
#       Support for a virtual alias domain looks like:
 
115
#
 
116
#       /etc/postfix/main.cf:
 
117
# .in +4
 
118
#       virtual_alias_maps = hash:/etc/postfix/virtual
 
119
#
 
120
#       Note: some systems use \fBdbm\fR databases instead of \fBhash\fR.
 
121
#       See the output from \fBpostconf -m\fR for available database types.
 
122
#
 
123
# .ti -4
 
124
#       /etc/postfix/virtual:
 
125
# .nf
 
126
# .na
 
127
#       \fIvirtual-alias.domain anything\fR (right-hand content does not matter)
 
128
#       \fIpostmaster@virtual-alias.domain      postmaster\fR
 
129
#       \fIuser1@virtual-alias.domain   address1\fR
 
130
#       \fIuser2@virtual-alias.domain   address2, address3\fR
 
131
# .fi
 
132
# .in -4
 
133
# .ad
 
134
# .fi
 
135
# .sp
 
136
#       The \fIvirtual-alias.domain anything\fR entry is required for a
 
137
#       virtual alias domain. \fBWithout this entry, mail is rejected
 
138
#       with "relay access denied", or bounces with 
 
139
#       "mail loops back to myself".\fR
 
140
#
 
141
#       Do not specify virtual alias domain names in the \fBmain.cf
 
142
#       mydestination\fR or \fBrelay_domains\fR configuration parameters.
 
143
#
 
144
#       With a virtual alias domain, the Postfix SMTP server
 
145
#       accepts mail for \fIknown-user@virtual-alias.domain\fR, and rejects
 
146
#       mail for \fIunknown-user\fR@\fIvirtual-alias.domain\fR as undeliverable.
 
147
#
 
148
#       Instead of specifying the virtual alias domain name via
 
149
#       the \fBvirtual_alias_maps\fR table, you may also specify it via
 
150
#       the \fBmain.cf virtual_alias_domains\fR configuration parameter.
 
151
#       This latter parameter uses the same syntax as the \fBmain.cf
 
152
#       mydestination\fR configuration parameter.
 
153
# REGULAR EXPRESSION TABLES
 
154
# .ad
 
155
# .fi
 
156
#       This section describes how the table lookups change when the table
 
157
#       is given in the form of regular expressions. For a description of
 
158
#       regular expression lookup table syntax, see \fBregexp_table\fR(5)
 
159
#       or \fBpcre_table\fR(5).
 
160
#
 
161
#       Each pattern is a regular expression that is applied to the entire
 
162
#       address being looked up. Thus, \fIuser@domain\fR mail addresses are not
 
163
#       broken up into their \fIuser\fR and \fI@domain\fR constituent parts,
 
164
#       nor is \fIuser+foo\fR broken up into \fIuser\fR and \fIfoo\fR.
 
165
#
 
166
#       Patterns are applied in the order as specified in the table, until a
 
167
#       pattern is found that matches the search string.
 
168
#
 
169
#       Results are the same as with indexed file lookups, with
 
170
#       the additional feature that parenthesized substrings from the
 
171
#       pattern can be interpolated as \fB$1\fR, \fB$2\fR and so on.
 
172
# TCP-BASED TABLES
 
173
# .ad
 
174
# .fi
 
175
#       This section describes how the table lookups change when lookups
 
176
#       are directed to a TCP-based server. For a description of the TCP
 
177
#       client/server lookup protocol, see \fBtcp_table\fR(5).
 
178
#       This feature is not available in Postfix version 2.1.
 
179
#
 
180
#       Each lookup operation uses the entire address once.  Thus,
 
181
#       \fIuser@domain\fR mail addresses are not broken up into their
 
182
#       \fIuser\fR and \fI@domain\fR constituent parts, nor is
 
183
#       \fIuser+foo\fR broken up into \fIuser\fR and \fIfoo\fR.
 
184
#
 
185
#       Results are the same as with indexed file lookups.
 
186
# BUGS
 
187
#       The table format does not understand quoting conventions.
 
188
# CONFIGURATION PARAMETERS
 
189
# .ad
 
190
# .fi
 
191
#       The following \fBmain.cf\fR parameters are especially relevant to
 
192
#       this topic. See the Postfix \fBmain.cf\fR file for syntax details
 
193
#       and for default values. Use the \fBpostfix reload\fR command after
 
194
#       a configuration change.
 
195
# .IP \fBvirtual_alias_maps\fR
 
196
#       List of virtual aliasing tables.
 
197
# .IP \fBvirtual_alias_domains\fR
 
198
#       List of virtual alias domains. This uses the same syntax
 
199
#       as the \fBmydestination\fR parameter.
 
200
# .IP \fBpropagate_unmatched_extensions\fR
 
201
#       A list of address rewriting or forwarding mechanisms that propagate   
 
202
#       an address extension from the original address to the result.     
 
203
#       Specify zero or more of \fBcanonical\fR, \fBvirtual\fR, \fBalias\fR,
 
204
#       \fBforward\fR, or \fBinclude\fR.
 
205
# .PP
 
206
#       Other parameters of interest:
 
207
# .IP \fBinet_interfaces\fR
 
208
#       The network interface addresses that this system receives mail on.
 
209
#       You need to stop and start Postfix when this parameter changes.
 
210
# .IP \fBmydestination\fR
 
211
#       List of domains that this mail system considers local.
 
212
# .IP \fBmyorigin\fR
 
213
#       The domain that is appended to any address that does not have a domain.
 
214
# .IP \fBowner_request_special\fR
 
215
#       Give special treatment to \fBowner-\fIxxx\fR and \fIxxx\fB-request\fR
 
216
#       addresses.
 
217
# .IP \fBproxy_interfaces\fR
 
218
#       Other interfaces that this machine receives mail on by way of a
 
219
#       proxy agent or network address translator.
 
220
# SEE ALSO
 
221
#       cleanup(8), canonicalize and enqueue mail
 
222
#       postmap(1), Postfix lookup table manager
 
223
#       postconf(5), configuration parameters
 
224
#       canonical(5), canonical address mapping
 
225
# README FILES
 
226
# .ad
 
227
# .fi
 
228
#       Use "\fBpostconf readme_directory\fR" or
 
229
#       "\fBpostconf html_directory\fR" to locate this information.
 
230
# .na
 
231
# .nf
 
232
#       DATABASE_README, Postfix lookup table overview
 
233
#       ADDRESS_REWRITING_README, address rewriting guide
 
234
#       VIRTUAL_README, domain hosting guide
 
235
# LICENSE
 
236
# .ad
 
237
# .fi
 
238
#       The Secure Mailer license must be distributed with this software.
 
239
# AUTHOR(S)
 
240
#       Wietse Venema
 
241
#       IBM T.J. Watson Research
 
242
#       P.O. Box 704
 
243
#       Yorktown Heights, NY 10598, USA
 
244
#--