Expand PMF_FN_* macros.
[netbsd-mini2440.git] / external / ibm-public / postfix / dist / conf / transport
blob0544b2779c3d603920e16e64a132fff017a9db72
1 # TRANSPORT(5)                                                      TRANSPORT(5)
2
3 # NAME
4 #        transport - Postfix transport table format
5
6 # SYNOPSIS
7 #        postmap /etc/postfix/transport
8
9 #        postmap -q "string" /etc/postfix/transport
10
11 #        postmap -q - /etc/postfix/transport <inputfile
12
13 # DESCRIPTION
14 #        The  optional  transport(5) table specifies a mapping from
15 #        email addresses to message delivery transports  and  next-
16 #        hop  destinations.   Message  delivery  transports such as
17 #        local or smtp are defined in the master.cf file, and next-
18 #        hop  destinations are typically hosts or domain names. The
19 #        table is searched by the trivial-rewrite(8) daemon.
20
21 #        This  mapping  overrides  the  default   transport:nexthop
22 #        selection that is built into Postfix:
23
24 #        local_transport (default: local:$myhostname)
25 #               This  is  the default for final delivery to domains
26 #               listed with mydestination, and for [ipaddress] des-
27 #               tinations    that    match    $inet_interfaces   or
28 #               $proxy_interfaces. The default nexthop  destination
29 #               is the MTA hostname.
30
31 #        virtual_transport (default: virtual:)
32 #               This  is  the default for final delivery to domains
33 #               listed with  virtual_mailbox_domains.  The  default
34 #               nexthop destination is the recipient domain.
35
36 #        relay_transport (default: relay:)
37 #               This  is the default for remote delivery to domains
38 #               listed with relay_domains. In order  of  decreasing
39 #               precedence,  the  nexthop destination is taken from
40 #               relay_transport,   sender_dependent_relayhost_maps,
41 #               relayhost, or from the recipient domain.
42
43 #        default_transport (default: smtp:)
44 #               This  is  the  default for remote delivery to other
45 #               destinations.  In order of  decreasing  precedence,
46 #               the    nexthop    destination    is    taken   from
47 #               default_transport, sender_dependent_relayhost_maps,
48 #               relayhost, or from the recipient domain.
49
50 #        Normally,  the  transport(5)  table is specified as a text
51 #        file that serves as input to the postmap(1) command.   The
52 #        result,  an  indexed file in dbm or db format, is used for
53 #        fast searching by the mail  system.  Execute  the  command
54 #        "postmap  /etc/postfix/transport"  to  rebuild  an indexed
55 #        file after changing the corresponding transport table.
56
57 #        When the table is provided via other means  such  as  NIS,
58 #        LDAP  or  SQL,  the  same lookups are done as for ordinary
59 #        indexed files.
60
61 #        Alternatively, the table can be  provided  as  a  regular-
62 #        expression map where patterns are given as regular expres-
63 #        sions, or lookups can be directed to TCP-based server.  In
64 #        those  case,  the lookups are done in a slightly different
65 #        way as described below under "REGULAR  EXPRESSION  TABLES"
66 #        or "TCP-BASED TABLES".
67
68 # CASE FOLDING
69 #        The  search  string is folded to lowercase before database
70 #        lookup. As of Postfix 2.3, the search string is  not  case
71 #        folded  with database types such as regexp: or pcre: whose
72 #        lookup fields can match both upper and lower case.
73
74 # TABLE FORMAT
75 #        The input format for the postmap(1) command is as follows:
76
77 #        pattern result
78 #               When  pattern  matches  the  recipient  address  or
79 #               domain, use the corresponding result.
80
81 #        blank lines and comments
82 #               Empty lines and whitespace-only lines are  ignored,
83 #               as  are  lines whose first non-whitespace character
84 #               is a `#'.
85
86 #        multi-line text
87 #               A logical line starts with non-whitespace  text.  A
88 #               line  that starts with whitespace continues a logi-
89 #               cal line.
90
91 #        The pattern specifies an email address, a domain name,  or
92 #        a  domain  name  hierarchy, as described in section "TABLE
93 #        LOOKUP".
94
95 #        The result is of the form transport:nexthop and  specifies
96 #        how or where to deliver mail. This is described in section
97 #        "RESULT FORMAT".
98
99 # TABLE SEARCH ORDER
100 #        With lookups from indexed files such as DB or DBM, or from
101 #        networked  tables  such  as NIS, LDAP or SQL, patterns are
102 #        tried in the order as listed below:
104 #        user+extension@domain transport:nexthop
105 #               Deliver  mail  for  user+extension@domain   through
106 #               transport to nexthop.
108 #        user@domain transport:nexthop
109 #               Deliver  mail  for user@domain through transport to
110 #               nexthop.
112 #        domain transport:nexthop
113 #               Deliver mail for domain through transport  to  nex-
114 #               thop.
116 #        .domain transport:nexthop
117 #               Deliver  mail  for  any subdomain of domain through
118 #               transport to nexthop. This applies  only  when  the
119 #               string  transport_maps  is  not  listed in the par-
120 #               ent_domain_matches_subdomains  configuration   set-
121 #               ting.   Otherwise, a domain name matches itself and
122 #               its subdomains.
124 #        * transport:nexthop
125 #               The special pattern * represents any address  (i.e.
126 #               it  functions  as  the  wild-card  pattern,  and is
127 #               unique to Postfix transport tables).
129 #        Note 1:  the  null  recipient  address  is  looked  up  as
130 #        $empty_address_recipient@$myhostname (default: mailer-dae-
131 #        mon@hostname).
133 #        Note 2: user@domain  or  user+extension@domain  lookup  is
134 #        available in Postfix 2.0 and later.
136 # RESULT FORMAT
137 #        The  lookup  result is of the form transport:nexthop.  The
138 #        transport field specifies a mail delivery  transport  such
139 #        as  smtp  or  local. The nexthop field specifies where and
140 #        how to deliver mail.
142 #        The transport field specifies the name of a mail  delivery
143 #        transport (the first name of a mail delivery service entry
144 #        in the Postfix master.cf file).
146 #        The interpretation  of  the  nexthop  field  is  transport
147 #        dependent.  In  the  case  of SMTP, specify a service on a
148 #        non-default port as host:service,  and  disable  MX  (mail
149 #        exchanger)  DNS lookups with [host] or [host]:port. The []
150 #        form is required when you specify an IP address instead of
151 #        a hostname.
153 #        A  null  transport  and  null nexthop result means "do not
154 #        change": use the delivery transport and  nexthop  informa-
155 #        tion  that  would  be used when the entire transport table
156 #        did not exist.
158 #        A non-null transport  field  with  a  null  nexthop  field
159 #        resets the nexthop information to the recipient domain.
161 #        A  null  transport  field with non-null nexthop field does
162 #        not modify the transport information.
164 # EXAMPLES
165 #        In order to deliver internal mail directly, while using  a
166 #        mail  relay  for  all other mail, specify a null entry for
167 #        internal destinations (do not change the  delivery  trans-
168 #        port  or  the  nexthop information) and specify a wildcard
169 #        for all other destinations.
171 #             my.domain    :
172 #             .my.domain   :
173 #             *            smtp:outbound-relay.my.domain
175 #        In order to send mail for example.com and  its  subdomains
176 #        via the uucp transport to the UUCP host named example:
178 #             example.com      uucp:example
179 #             .example.com     uucp:example
181 #        When  no  nexthop  host name is specified, the destination
182 #        domain name is used instead. For  example,  the  following
183 #        directs  mail  for user@example.com via the slow transport
184 #        to a mail exchanger for example.com.  The  slow  transport
185 #        could be configured to run at most one delivery process at
186 #        a time:
188 #             example.com      slow:
190 #        When no transport is specified, Postfix uses the transport
191 #        that  matches  the  address  domain class (see DESCRIPTION
192 #        above).  The following sends all mail for example.com  and
193 #        its subdomains to host gateway.example.com:
195 #             example.com      :[gateway.example.com]
196 #             .example.com     :[gateway.example.com]
198 #        In  the  above  example, the [] suppress MX lookups.  This
199 #        prevents mail routing loops when your machine  is  primary
200 #        MX host for example.com.
202 #        In  the  case  of delivery via SMTP, one may specify host-
203 #        name:service instead of just a host:
205 #             example.com      smtp:bar.example:2025
207 #        This directs mail for user@example.com to host bar.example
208 #        port 2025. Instead of a numerical port a symbolic name may
209 #        be used. Specify [] around the hostname if MX lookups must
210 #        be disabled.
212 #        The error mailer can be used to bounce mail:
214 #             .example.com     error:mail for *.example.com is not deliverable
216 #        This  causes  all mail for user@anything.example.com to be
217 #        bounced.
219 # REGULAR EXPRESSION TABLES
220 #        This section describes how the table lookups  change  when
221 #        the table is given in the form of regular expressions. For
222 #        a description of regular expression lookup  table  syntax,
223 #        see regexp_table(5) or pcre_table(5).
225 #        Each  pattern  is  a regular expression that is applied to
226 #        the   entire    address    being    looked    up.    Thus,
227 #        some.domain.hierarchy  is  not  looked  up  via its parent
228 #        domains, nor is user+foo@domain looked up as  user@domain.
230 #        Patterns  are applied in the order as specified in the ta-
231 #        ble, until a pattern is  found  that  matches  the  search
232 #        string.
234 #        The trivial-rewrite(8) server disallows regular expression
235 #        substitution of  $1  etc.  in  regular  expression  lookup
236 #        tables,  because  that could open a security hole (Postfix
237 #        version 2.3 and later).
239 # TCP-BASED TABLES
240 #        This section describes how the table lookups  change  when
241 #        lookups are directed to a TCP-based server. For a descrip-
242 #        tion of the TCP client/server lookup protocol, see tcp_ta-
243 #        ble(5).  This feature is not available up to and including
244 #        Postfix version 2.4.
246 #        Each lookup operation uses the  entire  recipient  address
247 #        once.   Thus,  some.domain.hierarchy  is not looked up via
248 #        its parent domains, nor is user+foo@domain  looked  up  as
249 #        user@domain.
251 #        Results are the same as with indexed file lookups.
253 # CONFIGURATION PARAMETERS
254 #        The  following main.cf parameters are especially relevant.
255 #        The text below provides  only  a  parameter  summary.  See
256 #        postconf(5) for more details including examples.
258 #        empty_address_recipient
259 #               The  address  that is looked up instead of the null
260 #               sender address.
262 #        parent_domain_matches_subdomains
263 #               List of Postfix features that use  domain.tld  pat-
264 #               terns   to  match  sub.domain.tld  (as  opposed  to
265 #               requiring .domain.tld patterns).
267 #        transport_maps
268 #               List of transport lookup tables.
270 # SEE ALSO
271 #        trivial-rewrite(8), rewrite and resolve addresses
272 #        master(5), master.cf file format
273 #        postconf(5), configuration parameters
274 #        postmap(1), Postfix lookup table manager
276 # README FILES
277 #        Use "postconf readme_directory" or  "postconf  html_direc-
278 #        tory" to locate this information.
279 #        ADDRESS_REWRITING_README, address rewriting guide
280 #        DATABASE_README, Postfix lookup table overview
281 #        FILTER_README, external content filter
283 # LICENSE
284 #        The  Secure  Mailer  license must be distributed with this
285 #        software.
287 # AUTHOR(S)
288 #        Wietse Venema
289 #        IBM T.J. Watson Research
290 #        P.O. Box 704
291 #        Yorktown Heights, NY 10598, USA
293 #                                                                   TRANSPORT(5)