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  regu-
26#        lar-expression  map  where  patterns  are given as regular
27#        expressions, or lookups can be  directed  to  a  TCP-based
28#        server.  In those case, the lookups are done in a slightly
29#        different way as described below under "REGULAR EXPRESSION
30#        TABLES" 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 available in Postfix 2.5 and later.
90#
91#        Each pattern is a regular expression that  is  applied  to
92#        the entire address being looked up. Thus, user@domain mail
93#        addresses are not broken up into their  user  and  @domain
94#        constituent parts, nor is user+foo broken up into user and
95#        foo.
96#
97#        Patterns are applied in the order as specified in the  ta-
98#        ble,  until  a  pattern  is  found that matches the search
99#        string.
100#
101#        Results are the same as with indexed  file  lookups,  with
102#        the  additional feature that parenthesized substrings from
103#        the pattern can be interpolated as $1, $2 and so on.
104#
105# TCP-BASED TABLES
106#        This section describes how the table lookups  change  when
107#        lookups are directed to a TCP-based server. For a descrip-
108#        tion of the TCP client/server lookup protocol, see tcp_ta-
109#        ble(5).   This  feature  is  available  in Postfix 2.5 and
110#        later.
111#
112#        Each lookup operation uses the entire address once.  Thus,
113#        user@domain  mail  addresses  are not broken up into their
114#        user and @domain constituent parts, nor is user+foo broken
115#        up into user and foo.
116#
117#        Results are the same as with indexed file lookups.
118#
119# BUGS
120#        The  table format does not understand quoting conventions.
121#
122# CONFIGURATION PARAMETERS
123#        The following main.cf parameters are especially  relevant.
124#        The  text  below  provides  only  a parameter summary. See
125#        postconf(5) for more details including examples.
126#
127#        relocated_maps (empty)
128#               Optional lookup tables with new contact information
129#               for users or domains that no longer exist.
130#
131#        Other parameters of interest:
132#
133#        inet_interfaces (all)
134#               The network interface addresses that this mail sys-
135#               tem receives mail on.
136#
137#        mydestination  ($myhostname,  localhost.$mydomain,  local-
138#        host)
139#               The list of domains  that  are  delivered  via  the
140#               $local_transport mail delivery transport.
141#
142#        myorigin ($myhostname)
143#               The domain name that locally-posted mail appears to
144#               come from, and that locally posted mail  is  deliv-
145#               ered to.
146#
147#        proxy_interfaces (empty)
148#               The network interface addresses that this mail sys-
149#               tem receives mail on by way of a proxy  or  network
150#               address translation unit.
151#
152# SEE ALSO
153#        trivial-rewrite(8), address resolver
154#        postmap(1), Postfix lookup table manager
155#        postconf(5), configuration parameters
156#
157# README FILES
158#        Use  "postconf  readme_directory" or "postconf html_direc-
159#        tory" to locate this information.
160#        DATABASE_README, Postfix lookup table overview
161#        ADDRESS_REWRITING_README, address rewriting guide
162#
163# LICENSE
164#        The Secure Mailer license must be  distributed  with  this
165#        software.
166#
167# AUTHOR(S)
168#        Wietse Venema
169#        IBM T.J. Watson Research
170#        P.O. Box 704
171#        Yorktown Heights, NY 10598, USA
172#
173#        Wietse Venema
174#        Google, Inc.
175#        111 8th Avenue
176#        New York, NY 10011, USA
177#
178#                                                                   RELOCATED(5)
179