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