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