xref: /netbsd-src/external/ibm-public/postfix/dist/html/relocated.5.html (revision 059c16a85b0b39d60ad6d18f53c09510815afa2b)
1<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
2        "http://www.w3.org/TR/html4/loose.dtd">
3<html> <head>
4<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5<link rel='stylesheet' type='text/css' href='postfix-doc.css'>
6<title> Postfix manual - relocated(5) </title>
7</head> <body> <pre>
8RELOCATED(5)                                                      RELOCATED(5)
9
10<b>NAME</b>
11       relocated - Postfix relocated table format
12
13<b>SYNOPSIS</b>
14       <b>postmap /etc/postfix/relocated</b>
15
16<b>DESCRIPTION</b>
17       The  optional  <a href="relocated.5.html"><b>relocated</b>(5)</a> table provides the information that is used
18       in "user has moved to <i>new</i><b>_</b><i>location</i>" bounce messages.
19
20       Normally, the <a href="relocated.5.html"><b>relocated</b>(5)</a> table is  specified  as  a  text  file  that
21       serves as input to the <a href="postmap.1.html"><b>postmap</b>(1)</a> command.  The result, an indexed file
22       in <b>dbm</b> or <b>db</b> format, is used for fast searching  by  the  mail  system.
23       Execute  the  command  "<b>postmap  /etc/postfix/relocated</b>"  to rebuild an
24       indexed file after changing the corresponding relocated table.
25
26       When the table is provided via other means such as NIS,  LDAP  or  SQL,
27       the same lookups are done as for ordinary indexed files.
28
29       Alternatively,  the  table  can be provided as a regular-expression map
30       where patterns are given as regular  expressions,  or  lookups  can  be
31       directed  to a TCP-based server. In those case, the lookups are done in
32       a slightly different way as described below under  "REGULAR  EXPRESSION
33       TABLES" or "TCP-BASED TABLES".
34
35       Table lookups are case insensitive.
36
37<b>CASE FOLDING</b>
38       The  search string is folded to lowercase before database lookup. As of
39       Postfix 2.3, the search string is not case folded with  database  types
40       such  as  <a href="regexp_table.5.html">regexp</a>: or <a href="pcre_table.5.html">pcre</a>: whose lookup fields can match both upper and
41       lower case.
42
43<b>TABLE FORMAT</b>
44       The input format for the <a href="postmap.1.html"><b>postmap</b>(1)</a> command is as follows:
45
46       <b>o</b>      An entry has one of the following form:
47
48                   <i>pattern      new</i><b>_</b><i>location</i>
49
50              Where <i>new</i><b>_</b><i>location</i> specifies  contact  information  such  as  an
51              email  address, or perhaps a street address or telephone number.
52
53       <b>o</b>      Empty lines and whitespace-only lines are ignored, as are  lines
54              whose first non-whitespace character is a `#'.
55
56       <b>o</b>      A  logical  line  starts  with  non-whitespace text. A line that
57              starts with whitespace continues a logical line.
58
59<b>TABLE SEARCH ORDER</b>
60       With lookups from indexed files such as DB or DBM,  or  from  networked
61       tables  such  as  NIS,  LDAP or SQL, patterns are tried in the order as
62       listed below:
63
64       <i>user</i>@<i>domain</i>
65              Matches <i>user</i>@<i>domain</i>. This form has  precedence  over  all  other
66              forms.
67
68       <i>user</i>   Matches <i>user</i>@<i>site</i> when <i>site</i> is $<b><a href="postconf.5.html#myorigin">myorigin</a></b>, when <i>site</i> is listed in
69              $<b><a href="postconf.5.html#mydestination">mydestination</a></b>, or when <i>site</i> is listed  in  $<b><a href="postconf.5.html#inet_interfaces">inet_interfaces</a></b>  or
70              $<b><a href="postconf.5.html#proxy_interfaces">proxy_interfaces</a></b>.
71
72       @<i>domain</i>
73              Matches  other  addresses  in  <i>domain</i>.  This form has the lowest
74              precedence.
75
76<b>ADDRESS EXTENSION</b>
77       When a mail address localpart contains the optional recipient delimiter
78       (e.g.,  <i>user+foo</i>@<i>domain</i>),  the  lookup  order becomes: <i>user+foo</i>@<i>domain</i>,
79       <i>user</i>@<i>domain</i>, <i>user+foo</i>, <i>user</i>, and @<i>domain</i>.
80
81<b>REGULAR EXPRESSION TABLES</b>
82       This section describes how the table lookups change when the  table  is
83       given  in  the form of regular expressions or when lookups are directed
84       to a TCP-based server. For a description of regular  expression  lookup
85       table  syntax,  see <a href="regexp_table.5.html"><b>regexp_table</b>(5)</a> or <a href="pcre_table.5.html"><b>pcre_table</b>(5)</a>. For a description
86       of the TCP client/server table lookup protocol, see <a href="tcp_table.5.html"><b>tcp_table</b>(5)</a>.  This
87       feature is available in Postfix 2.5 and later.
88
89       Each  pattern  is  a  regular  expression that is applied to the entire
90       address being looked up. Thus, <i>user@domain</i> mail addresses are not  bro-
91       ken  up  into their <i>user</i> and <i>@domain</i> constituent parts, nor is <i>user+foo</i>
92       broken up into <i>user</i> and <i>foo</i>.
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 the additional
98       feature that parenthesized substrings from the pattern can be  interpo-
99       lated as <b>$1</b>, <b>$2</b> and so on.
100
101<b>TCP-BASED TABLES</b>
102       This  section  describes  how the table lookups change when lookups are
103       directed  to  a  TCP-based  server.  For  a  description  of  the   TCP
104       client/server  lookup  protocol,  see  <a href="tcp_table.5.html"><b>tcp_table</b>(5)</a>.   This  feature is
105       available in Postfix 2.5 and later.
106
107       Each lookup operation uses the entire address once.  Thus,  <i>user@domain</i>
108       mail  addresses  are  not  broken  up  into their <i>user</i> and <i>@domain</i> con-
109       stituent parts, nor is <i>user+foo</i> broken up into <i>user</i> and <i>foo</i>.
110
111       Results are the same as with indexed file lookups.
112
113<b>BUGS</b>
114       The table format does not understand quoting conventions.
115
116<b>CONFIGURATION PARAMETERS</b>
117       The following <a href="postconf.5.html"><b>main.cf</b></a> parameters are  especially  relevant.   The  text
118       below  provides  only  a  parameter  summary.  See <a href="postconf.5.html"><b>postconf</b>(5)</a> for more
119       details including examples.
120
121       <b><a href="postconf.5.html#relocated_maps">relocated_maps</a> (empty)</b>
122              Optional lookup tables with new contact information for users or
123              domains that no longer exist.
124
125       Other parameters of interest:
126
127       <b><a href="postconf.5.html#inet_interfaces">inet_interfaces</a> (all)</b>
128              The  network  interface addresses that this mail system receives
129              mail on.
130
131       <b><a href="postconf.5.html#mydestination">mydestination</a> ($<a href="postconf.5.html#myhostname">myhostname</a>, localhost.$<a href="postconf.5.html#mydomain">mydomain</a>, localhost)</b>
132              The list of domains that are delivered via the  $<a href="postconf.5.html#local_transport">local_transport</a>
133              mail delivery transport.
134
135       <b><a href="postconf.5.html#myorigin">myorigin</a> ($<a href="postconf.5.html#myhostname">myhostname</a>)</b>
136              The  domain  name that locally-posted mail appears to come from,
137              and that locally posted mail is delivered to.
138
139       <b><a href="postconf.5.html#proxy_interfaces">proxy_interfaces</a> (empty)</b>
140              The network interface addresses that this mail  system  receives
141              mail on by way of a proxy or network address translation unit.
142
143<b>SEE ALSO</b>
144       <a href="trivial-rewrite.8.html">trivial-rewrite(8)</a>, address resolver
145       <a href="postmap.1.html">postmap(1)</a>, Postfix lookup table manager
146       <a href="postconf.5.html">postconf(5)</a>, configuration parameters
147
148<b>README FILES</b>
149       <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview
150       <a href="ADDRESS_REWRITING_README.html">ADDRESS_REWRITING_README</a>, address rewriting guide
151
152<b>LICENSE</b>
153       The Secure Mailer license must be distributed with this software.
154
155<b>AUTHOR(S)</b>
156       Wietse Venema
157       IBM T.J. Watson Research
158       P.O. Box 704
159       Yorktown Heights, NY 10598, USA
160
161       Wietse Venema
162       Google, Inc.
163       111 8th Avenue
164       New York, NY 10011, USA
165
166                                                                  RELOCATED(5)
167</pre> </body> </html>
168