postfix-master/relocated.5.html

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