~ubuntu-branches/ubuntu/trusty/postfix/trusty-proposed

« back to all changes in this revision

Viewing changes to proto/relocated

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2005-02-27 09:33:07 UTC
  • Revision ID: james.westby@ubuntu.com-20050227093307-cn789t27ibnlh6tf
Tags: upstream-2.1.5
ImportĀ upstreamĀ versionĀ 2.1.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#++
 
2
# NAME
 
3
#       relocated 5
 
4
# SUMMARY
 
5
#       format of Postfix relocated table
 
6
# SYNOPSIS
 
7
#       \fBpostmap /etc/postfix/relocated\fR
 
8
# DESCRIPTION
 
9
#       The optional \fBrelocated\fR table provides the information that is
 
10
#       used in "user has moved to \fInew_location\fR" bounce messages.
 
11
#
 
12
#       Normally, the \fBrelocated\fR table is specified as a text file
 
13
#       that serves as input to the \fBpostmap\fR(1) command.
 
14
#       The result, an indexed file in \fBdbm\fR or \fBdb\fR format,
 
15
#       is used for fast searching by the mail system. Execute the command
 
16
#       \fBpostmap /etc/postfix/relocated\fR in order to rebuild the indexed
 
17
#       file after changing the relocated table.
 
18
#
 
19
#       When the table is provided via other means such as NIS, LDAP
 
20
#       or SQL, the same lookups are done as for ordinary indexed files.
 
21
#
 
22
#       Alternatively, the table can be provided as a regular-expression
 
23
#       map where patterns are given as regular expressions, or lookups
 
24
#       can be directed to TCP-based server. In that case, the lookups are
 
25
#       done in a slightly different way as described below under
 
26
#       "REGULAR EXPRESSION TABLES" and "TCP-BASED TABLES".
 
27
#
 
28
#       Table lookups are case insensitive.
 
29
# TABLE FORMAT
 
30
# .ad
 
31
# .fi
 
32
#       The input format for the \fBpostmap\fR(1) command is as follows:
 
33
# .IP \(bu
 
34
#       An entry has one of the following form:
 
35
# .ti +5
 
36
#       \fIpattern      new_location\fR
 
37
# .br
 
38
#       Where \fInew_location\fR specifies contact information such as
 
39
#       an email address, or perhaps a street address or telephone number.
 
40
# .IP \(bu
 
41
#       Empty lines and whitespace-only lines are ignored, as
 
42
#       are lines whose first non-whitespace character is a `#'.
 
43
# .IP \(bu
 
44
#       A logical line starts with non-whitespace text. A line that
 
45
#       starts with whitespace continues a logical line.
 
46
# .PP
 
47
#       With lookups from indexed files such as DB or DBM, or from networked
 
48
#       tables such as NIS, LDAP or SQL, patterns are tried in the order as
 
49
#       listed below:
 
50
# .IP \fIuser\fR@\fIdomain\fR
 
51
#       Matches \fIuser\fR@\fIdomain\fR. This form has precedence over all
 
52
#       other forms.
 
53
# .IP \fIuser\fR
 
54
#       Matches \fIuser\fR@\fIsite\fR when \fIsite\fR is $\fBmyorigin\fR,
 
55
#       when \fIsite\fR is listed in $\fBmydestination\fR, or when \fIsite\fR
 
56
#       is listed in $\fBinet_interfaces\fR or $\fBproxy_interfaces\fR.
 
57
# .IP @\fIdomain\fR
 
58
#       Matches every address in \fIdomain\fR. This form has the lowest
 
59
#       precedence.
 
60
# ADDRESS EXTENSION
 
61
# .fi
 
62
# .ad
 
63
#       When a mail address localpart contains the optional recipient delimiter
 
64
#       (e.g., \fIuser+foo\fR@\fIdomain\fR), the lookup order becomes:
 
65
#       \fIuser+foo\fR@\fIdomain\fR, \fIuser\fR@\fIdomain\fR, \fIuser+foo\fR,
 
66
#       \fIuser\fR, and @\fIdomain\fR.
 
67
# REGULAR EXPRESSION TABLES
 
68
# .ad
 
69
# .fi
 
70
#       This section describes how the table lookups change when the table
 
71
#       is given in the form of regular expressions or when lookups are
 
72
#       directed to a TCP-based server. For a description of regular
 
73
#       expression lookup table syntax, see \fBregexp_table\fR(5) or
 
74
#       \fBpcre_table\fR(5). For a description of the TCP client/server
 
75
#       table lookup protocol, see \fBtcp_table\fR(5).
 
76
#
 
77
#       Each pattern is a regular expression that is applied to the entire
 
78
#       address being looked up. Thus, \fIuser@domain\fR mail addresses are not
 
79
#       broken up into their \fIuser\fR and \fI@domain\fR constituent parts,
 
80
#       nor is \fIuser+foo\fR broken up into \fIuser\fR and \fIfoo\fR.
 
81
#
 
82
#       Patterns are applied in the order as specified in the table, until a
 
83
#       pattern is found that matches the search string.
 
84
#
 
85
#       Results are the same as with indexed file lookups, with
 
86
#       the additional feature that parenthesized substrings from the
 
87
#       pattern can be interpolated as \fB$1\fR, \fB$2\fR and so on.
 
88
# TCP-BASED TABLES
 
89
# .ad
 
90
# .fi
 
91
#       This section describes how the table lookups change when lookups
 
92
#       are directed to a TCP-based server. For a description of the TCP
 
93
#       client/server lookup protocol, see \fBtcp_table\fR(5).
 
94
#       This feature is not available in Postfix version 2.1.
 
95
#
 
96
#       Each lookup operation uses the entire address once.  Thus,
 
97
#       \fIuser@domain\fR mail addresses are not broken up into their
 
98
#       \fIuser\fR and \fI@domain\fR constituent parts, nor is
 
99
#       \fIuser+foo\fR broken up into \fIuser\fR and \fIfoo\fR.
 
100
#
 
101
#       Results are the same as with indexed file lookups.
 
102
# BUGS
 
103
#       The table format does not understand quoting conventions.
 
104
# CONFIGURATION PARAMETERS
 
105
# .ad
 
106
# .fi
 
107
#       The following \fBmain.cf\fR parameters are especially relevant.  
 
108
#       The text below provides only a parameter summary. See
 
109
#       postconf(5) for more details including examples.
 
110
# .IP \fBrelocated_maps\fR
 
111
#       List of lookup tables for relocated users or sites.
 
112
# .PP
 
113
#       Other parameters of interest:
 
114
# .IP \fBinet_interfaces\fR
 
115
#       The network interface addresses that this system receives mail on.
 
116
#       You need to stop and start Postfix when this parameter changes.
 
117
# .IP \fBmydestination\fR
 
118
#       List of domains that this mail system considers local.
 
119
# .IP \fBmyorigin\fR
 
120
#       The domain that is appended to locally-posted mail.
 
121
# .IP \fBproxy_interfaces\fR
 
122
#       Other interfaces that this machine receives mail on by way of a
 
123
#       proxy agent or network address translator.
 
124
# SEE ALSO
 
125
#       trivial-rewrite(8), address resolver
 
126
#       postmap(1), Postfix lookup table manager
 
127
#       postconf(5), configuration parameters
 
128
# README FILES
 
129
# .ad
 
130
# .fi
 
131
#       Use "\fBpostconf readme_directory\fR" or
 
132
#       "\fBpostconf html_directory\fR" to locate this information.
 
133
# .na
 
134
# .nf
 
135
#       DATABASE_README, Postfix lookup table overview
 
136
#       ADDRESS_REWRITING_README, address rewriting guide
 
137
# LICENSE
 
138
# .ad
 
139
# .fi
 
140
#       The Secure Mailer license must be distributed with this software.
 
141
# AUTHOR(S)
 
142
#       Wietse Venema
 
143
#       IBM T.J. Watson Research
 
144
#       P.O. Box 704
 
145
#       Yorktown Heights, NY 10598, USA
 
146
#--