~ubuntu-branches/ubuntu/dapper/postfix/dapper-security

« back to all changes in this revision

Viewing changes to man/man5/relocated.5

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2005-02-27 09:33:07 UTC
  • Revision ID: james.westby@ubuntu.com-20050227093307-cn789t27ibnlh6tf
Tags: upstream-2.1.5
ImportĀ upstreamĀ versionĀ 2.1.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH RELOCATED 5 
 
2
.ad
 
3
.fi
 
4
.SH NAME
 
5
relocated
 
6
\-
 
7
format of Postfix relocated table
 
8
.SH "SYNOPSIS"
 
9
.na
 
10
.nf
 
11
\fBpostmap /etc/postfix/relocated\fR
 
12
.SH DESCRIPTION
 
13
.ad
 
14
.fi
 
15
The optional \fBrelocated\fR table provides the information that is
 
16
used in "user has moved to \fInew_location\fR" bounce messages.
 
17
 
 
18
Normally, the \fBrelocated\fR table is specified as a text file
 
19
that serves as input to the \fBpostmap\fR(1) command.
 
20
The result, an indexed file in \fBdbm\fR or \fBdb\fR format,
 
21
is used for fast searching by the mail system. Execute the command
 
22
\fBpostmap /etc/postfix/relocated\fR in order to rebuild the indexed
 
23
file after changing the relocated table.
 
24
 
 
25
When the table is provided via other means such as NIS, LDAP
 
26
or SQL, the same lookups are done as for ordinary indexed files.
 
27
 
 
28
Alternatively, the table can be provided as a regular-expression
 
29
map where patterns are given as regular expressions, or lookups
 
30
can be directed to TCP-based server. In that case, the lookups are
 
31
done in a slightly different way as described below under
 
32
"REGULAR EXPRESSION TABLES" and "TCP-BASED TABLES".
 
33
 
 
34
Table lookups are case insensitive.
 
35
.SH "TABLE FORMAT"
 
36
.na
 
37
.nf
 
38
.ad
 
39
.fi
 
40
The input format for the \fBpostmap\fR(1) command is as follows:
 
41
.IP \(bu
 
42
An entry has one of the following form:
 
43
.ti +5
 
44
\fIpattern      new_location\fR
 
45
.br
 
46
Where \fInew_location\fR specifies contact information such as
 
47
an email address, or perhaps a street address or telephone number.
 
48
.IP \(bu
 
49
Empty lines and whitespace-only lines are ignored, as
 
50
are lines whose first non-whitespace character is a `#'.
 
51
.IP \(bu
 
52
A logical line starts with non-whitespace text. A line that
 
53
starts with whitespace continues a logical line.
 
54
.PP
 
55
With lookups from indexed files such as DB or DBM, or from networked
 
56
tables such as NIS, LDAP or SQL, patterns are tried in the order as
 
57
listed below:
 
58
.IP \fIuser\fR@\fIdomain\fR
 
59
Matches \fIuser\fR@\fIdomain\fR. This form has precedence over all
 
60
other forms.
 
61
.IP \fIuser\fR
 
62
Matches \fIuser\fR@\fIsite\fR when \fIsite\fR is $\fBmyorigin\fR,
 
63
when \fIsite\fR is listed in $\fBmydestination\fR, or when \fIsite\fR
 
64
is listed in $\fBinet_interfaces\fR or $\fBproxy_interfaces\fR.
 
65
.IP @\fIdomain\fR
 
66
Matches every address in \fIdomain\fR. This form has the lowest
 
67
precedence.
 
68
.SH "ADDRESS EXTENSION"
 
69
.na
 
70
.nf
 
71
.fi
 
72
.ad
 
73
When a mail address localpart contains the optional recipient delimiter
 
74
(e.g., \fIuser+foo\fR@\fIdomain\fR), the lookup order becomes:
 
75
\fIuser+foo\fR@\fIdomain\fR, \fIuser\fR@\fIdomain\fR, \fIuser+foo\fR,
 
76
\fIuser\fR, and @\fIdomain\fR.
 
77
.SH "REGULAR EXPRESSION TABLES"
 
78
.na
 
79
.nf
 
80
.ad
 
81
.fi
 
82
This section describes how the table lookups change when the table
 
83
is given in the form of regular expressions or when lookups are
 
84
directed to a TCP-based server. For a description of regular
 
85
expression lookup table syntax, see \fBregexp_table\fR(5) or
 
86
\fBpcre_table\fR(5). For a description of the TCP client/server
 
87
table lookup protocol, see \fBtcp_table\fR(5).
 
88
 
 
89
Each pattern is a regular expression that is applied to the entire
 
90
address being looked up. Thus, \fIuser@domain\fR mail addresses are not
 
91
broken up into their \fIuser\fR and \fI@domain\fR constituent parts,
 
92
nor is \fIuser+foo\fR broken up into \fIuser\fR and \fIfoo\fR.
 
93
 
 
94
Patterns are applied in the order as specified in the table, until a
 
95
pattern is found that matches the search string.
 
96
 
 
97
Results are the same as with indexed file lookups, with
 
98
the additional feature that parenthesized substrings from the
 
99
pattern can be interpolated as \fB$1\fR, \fB$2\fR and so on.
 
100
.SH "TCP-BASED TABLES"
 
101
.na
 
102
.nf
 
103
.ad
 
104
.fi
 
105
This section describes how the table lookups change when lookups
 
106
are directed to a TCP-based server. For a description of the TCP
 
107
client/server lookup protocol, see \fBtcp_table\fR(5).
 
108
This feature is not available in Postfix version 2.1.
 
109
 
 
110
Each lookup operation uses the entire address once.  Thus,
 
111
\fIuser@domain\fR mail addresses are not broken up into their
 
112
\fIuser\fR and \fI@domain\fR constituent parts, nor is
 
113
\fIuser+foo\fR broken up into \fIuser\fR and \fIfoo\fR.
 
114
 
 
115
Results are the same as with indexed file lookups.
 
116
.SH BUGS
 
117
.ad
 
118
.fi
 
119
The table format does not understand quoting conventions.
 
120
.SH "CONFIGURATION PARAMETERS"
 
121
.na
 
122
.nf
 
123
.ad
 
124
.fi
 
125
The following \fBmain.cf\fR parameters are especially relevant.
 
126
The text below provides only a parameter summary. See
 
127
postconf(5) for more details including examples.
 
128
.IP \fBrelocated_maps\fR
 
129
List of lookup tables for relocated users or sites.
 
130
.PP
 
131
Other parameters of interest:
 
132
.IP \fBinet_interfaces\fR
 
133
The network interface addresses that this system receives mail on.
 
134
You need to stop and start Postfix when this parameter changes.
 
135
.IP \fBmydestination\fR
 
136
List of domains that this mail system considers local.
 
137
.IP \fBmyorigin\fR
 
138
The domain that is appended to locally-posted mail.
 
139
.IP \fBproxy_interfaces\fR
 
140
Other interfaces that this machine receives mail on by way of a
 
141
proxy agent or network address translator.
 
142
.SH "SEE ALSO"
 
143
.na
 
144
.nf
 
145
trivial-rewrite(8), address resolver
 
146
postmap(1), Postfix lookup table manager
 
147
postconf(5), configuration parameters
 
148
.SH "README FILES"
 
149
.na
 
150
.nf
 
151
.ad
 
152
.fi
 
153
Use "\fBpostconf readme_directory\fR" or
 
154
"\fBpostconf html_directory\fR" to locate this information.
 
155
.na
 
156
.nf
 
157
DATABASE_README, Postfix lookup table overview
 
158
ADDRESS_REWRITING_README, address rewriting guide
 
159
.SH "LICENSE"
 
160
.na
 
161
.nf
 
162
.ad
 
163
.fi
 
164
The Secure Mailer license must be distributed with this software.
 
165
.SH "AUTHOR(S)"
 
166
.na
 
167
.nf
 
168
Wietse Venema
 
169
IBM T.J. Watson Research
 
170
P.O. Box 704
 
171
Yorktown Heights, NY 10598, USA