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