summaryrefslogtreecommitdiffstats
path: root/html/relocated.5.html
blob: efd2f53adc51d0670447cdc2d9d19744cca0f9c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
        "http://www.w3.org/TR/html4/loose.dtd">
<html> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel='stylesheet' type='text/css' href='postfix-doc.css'>
<title> Postfix manual - relocated(5) </title>
</head> <body> <pre>
RELOCATED(5)                                                      RELOCATED(5)

<b>NAME</b>
       relocated - Postfix relocated table format

<b>SYNOPSIS</b>
       <b>postmap /etc/postfix/relocated</b>

<b>DESCRIPTION</b>
       The  optional  <a href="relocated.5.html"><b>relocated</b>(5)</a> table provides the information that is used
       in "user has moved to <i>new</i><b>_</b><i>location</i>" bounce messages.

       Normally, the <a href="relocated.5.html"><b>relocated</b>(5)</a> table is  specified  as  a  text  file  that
       serves as input to the <a href="postmap.1.html"><b>postmap</b>(1)</a> command.  The result, an indexed file
       in <b>dbm</b> or <b>db</b> format, is used for fast searching  by  the  mail  system.
       Execute  the  command  "<b>postmap  /etc/postfix/relocated</b>"  to rebuild an
       indexed file after changing the corresponding relocated table.

       When the table is provided via other means such as NIS,  LDAP  or  SQL,
       the same lookups are done as for ordinary indexed files.

       Alternatively,  the  table  can be provided as a regular-expression map
       where patterns are given as regular  expressions,  or  lookups  can  be
       directed  to a TCP-based server. In those case, the lookups are done in
       a slightly different way as described below under  "REGULAR  EXPRESSION
       TABLES" or "TCP-BASED TABLES".

       Table lookups are case insensitive.

<b>CASE FOLDING</b>
       The  search string is folded to lowercase before database lookup. As of
       Postfix 2.3, the search string is not case folded with  database  types
       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
       lower case.

<b>TABLE FORMAT</b>
       The input format for the <a href="postmap.1.html"><b>postmap</b>(1)</a> command is as follows:

       <b>o</b>      An entry has one of the following form:

                   <i>pattern      new</i><b>_</b><i>location</i>

              Where <i>new</i><b>_</b><i>location</i> specifies  contact  information  such  as  an
              email  address, or perhaps a street address or telephone number.

       <b>o</b>      Empty lines and whitespace-only lines are ignored, as are  lines
              whose first non-whitespace character is a `#'.

       <b>o</b>      A  logical  line  starts  with  non-whitespace text. A line that
              starts with whitespace continues a logical line.

<b>TABLE SEARCH ORDER</b>
       With lookups from indexed files such as DB or DBM,  or  from  networked
       tables  such  as  NIS,  LDAP or SQL, patterns are tried in the order as
       listed below:

       <i>user</i>@<i>domain</i>
              Matches <i>user</i>@<i>domain</i>. This form has  precedence  over  all  other
              forms.

       <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
              $<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
              $<b><a href="postconf.5.html#proxy_interfaces">proxy_interfaces</a></b>.

       @<i>domain</i>
              Matches  other  addresses  in  <i>domain</i>.  This form has the lowest
              precedence.

<b>ADDRESS EXTENSION</b>
       When a mail address localpart contains the optional recipient delimiter
       (e.g.,  <i>user+foo</i>@<i>domain</i>),  the  lookup  order becomes: <i>user+foo</i>@<i>domain</i>,
       <i>user</i>@<i>domain</i>, <i>user+foo</i>, <i>user</i>, and @<i>domain</i>.

<b>REGULAR EXPRESSION TABLES</b>
       This section describes how the table lookups change when the  table  is
       given  in  the form of regular expressions or when lookups are directed
       to a TCP-based server. For a description of regular  expression  lookup
       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
       of the TCP client/server table lookup protocol, see <a href="tcp_table.5.html"><b>tcp_table</b>(5)</a>.  This
       feature is available in Postfix 2.5 and later.

       Each  pattern  is  a  regular  expression that is applied to the entire
       address being looked up. Thus, <i>user@domain</i> mail addresses are not  bro-
       ken  up  into their <i>user</i> and <i>@domain</i> constituent parts, nor is <i>user+foo</i>
       broken up into <i>user</i> and <i>foo</i>.

       Patterns are applied in the order as specified in the  table,  until  a
       pattern is found that matches the search string.

       Results  are the same as with indexed file lookups, with the additional
       feature that parenthesized substrings from the pattern can be  interpo-
       lated as <b>$1</b>, <b>$2</b> and so on.

<b>TCP-BASED TABLES</b>
       This  section  describes  how the table lookups change when lookups are
       directed  to  a  TCP-based  server.  For  a  description  of  the   TCP
       client/server  lookup  protocol,  see  <a href="tcp_table.5.html"><b>tcp_table</b>(5)</a>.   This  feature is
       available in Postfix 2.5 and later.

       Each lookup operation uses the entire address once.  Thus,  <i>user@domain</i>
       mail  addresses  are  not  broken  up  into their <i>user</i> and <i>@domain</i> con-
       stituent parts, nor is <i>user+foo</i> broken up into <i>user</i> and <i>foo</i>.

       Results are the same as with indexed file lookups.

<b>BUGS</b>
       The table format does not understand quoting conventions.

<b>CONFIGURATION PARAMETERS</b>
       The following <a href="postconf.5.html"><b>main.cf</b></a> parameters are  especially  relevant.   The  text
       below  provides  only  a  parameter  summary.  See <a href="postconf.5.html"><b>postconf</b>(5)</a> for more
       details including examples.

       <b><a href="postconf.5.html#relocated_maps">relocated_maps</a> (empty)</b>
              Optional lookup tables with new contact information for users or
              domains that no longer exist.

       Other parameters of interest:

       <b><a href="postconf.5.html#inet_interfaces">inet_interfaces</a> (all)</b>
              The  network  interface addresses that this mail system receives
              mail on.

       <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>
              The list of domains that are delivered via the  $<a href="postconf.5.html#local_transport">local_transport</a>
              mail delivery transport.

       <b><a href="postconf.5.html#myorigin">myorigin</a> ($<a href="postconf.5.html#myhostname">myhostname</a>)</b>
              The  domain  name that locally-posted mail appears to come from,
              and that locally posted mail is delivered to.

       <b><a href="postconf.5.html#proxy_interfaces">proxy_interfaces</a> (empty)</b>
              The network interface addresses that this mail  system  receives
              mail on by way of a proxy or network address translation unit.

<b>SEE ALSO</b>
       <a href="trivial-rewrite.8.html">trivial-rewrite(8)</a>, address resolver
       <a href="postmap.1.html">postmap(1)</a>, Postfix lookup table manager
       <a href="postconf.5.html">postconf(5)</a>, configuration parameters

<b>README FILES</b>
       <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview
       <a href="ADDRESS_REWRITING_README.html">ADDRESS_REWRITING_README</a>, address rewriting guide

<b>LICENSE</b>
       The Secure Mailer license must be distributed with this software.

<b>AUTHOR(S)</b>
       Wietse Venema
       IBM T.J. Watson Research
       P.O. Box 704
       Yorktown Heights, NY 10598, USA

       Wietse Venema
       Google, Inc.
       111 8th Avenue
       New York, NY 10011, USA

                                                                  RELOCATED(5)
</pre> </body> </html>