| blob | d5ab42a667fb8fd2f4f35d4e0434d4ae6dfce590 |
1 # GENERIC(5) GENERIC(5)
2 #
3 # NAME
4 # generic - Postfix generic table format
5 #
6 # SYNOPSIS
7 # postmap /etc/postfix/generic
8 #
9 # postmap -q "string" /etc/postfix/generic
10 #
11 # postmap -q - /etc/postfix/generic <inputfile
12 #
13 # DESCRIPTION
14 # The optional generic(5) table specifies an address mapping
15 # that applies when mail is delivered. This is the opposite
16 # of canonical(5) mapping, which applies when mail is
17 # received.
18 #
19 # Typically, one would use the generic(5) table on a system
20 # that does not have a valid Internet domain name and that
21 # uses something like localdomain.local instead. The
22 # generic(5) table is then used by the smtp(8) client to
23 # transform local mail addresses into valid Internet mail
24 # addresses when mail has to be sent across the Internet.
25 # See the EXAMPLE section at the end of this document.
26 #
27 # The generic(5) mapping affects both message header
28 # addresses (i.e. addresses that appear inside messages) and
29 # message envelope addresses (for example, the addresses
30 # that are used in SMTP protocol commands).
31 #
32 # Normally, the generic(5) table is specified as a text file
33 # that serves as input to the postmap(1) command. The
34 # result, an indexed file in dbm or db format, is used for
35 # fast searching by the mail system. Execute the command
36 # "postmap /etc/postfix/generic" to rebuild an indexed file
37 # after changing the corresponding text file.
38 #
39 # When the table is provided via other means such as NIS,
40 # LDAP or SQL, the same lookups are done as for ordinary
41 # indexed files.
42 #
43 # Alternatively, the table can be provided as a regular-
44 # expression map where patterns are given as regular expres-
45 # sions, or lookups can be directed to TCP-based server. In
46 # those case, the lookups are done in a slightly different
47 # way as described below under "REGULAR EXPRESSION TABLES"
48 # or "TCP-BASED TABLES".
49 #
50 # CASE FOLDING
51 # The search string is folded to lowercase before database
52 # lookup. As of Postfix 2.3, the search string is not case
53 # folded with database types such as regexp: or pcre: whose
54 # lookup fields can match both upper and lower case.
55 #
56 # TABLE FORMAT
57 # The input format for the postmap(1) command is as follows:
58 #
59 # pattern result
60 # When pattern matches a mail address, replace it by
61 # the corresponding result.
62 #
63 # blank lines and comments
64 # Empty lines and whitespace-only lines are ignored,
65 # as are lines whose first non-whitespace character
66 # is a `#'.
67 #
68 # multi-line text
69 # A logical line starts with non-whitespace text. A
70 # line that starts with whitespace continues a logi-
71 # cal line.
72 #
73 # TABLE SEARCH ORDER
74 # With lookups from indexed files such as DB or DBM, or from
75 # networked tables such as NIS, LDAP or SQL, patterns are
76 # tried in the order as listed below:
77 #
78 # user@domain address
79 # Replace user@domain by address. This form has the
80 # highest precedence.
81 #
82 # user address
83 # Replace user@site by address when site is equal to
84 # $myorigin, when site is listed in $mydestination,
85 # or when it is listed in $inet_interfaces or
86 # $proxy_interfaces.
87 #
88 # @domain address
89 # Replace other addresses in domain by address. This
90 # form has the lowest precedence.
91 #
92 # RESULT ADDRESS REWRITING
93 # The lookup result is subject to address rewriting:
94 #
95 # o When the result has the form @otherdomain, the
96 # result becomes the same user in otherdomain.
97 #
98 # o When "append_at_myorigin=yes", append "@$myorigin"
99 # to addresses without "@domain".
100 #
101 # o When "append_dot_mydomain=yes", append ".$mydomain"
102 # to addresses without ".domain".
103 #
104 # ADDRESS EXTENSION
105 # When a mail address localpart contains the optional recip-
106 # ient delimiter (e.g., user+foo@domain), the lookup order
107 # becomes: user+foo@domain, user@domain, user+foo, user, and
108 # @domain.
109 #
110 # The propagate_unmatched_extensions parameter controls
111 # whether an unmatched address extension (+foo) is propa-
112 # gated to the result of table lookup.
113 #
114 # REGULAR EXPRESSION TABLES
115 # This section describes how the table lookups change when
116 # the table is given in the form of regular expressions. For
117 # a description of regular expression lookup table syntax,
118 # see regexp_table(5) or pcre_table(5).
119 #
120 # Each pattern is a regular expression that is applied to
121 # the entire address being looked up. Thus, user@domain mail
122 # addresses are not broken up into their user and @domain
123 # constituent parts, nor is user+foo broken up into user and
124 # foo.
125 #
126 # Patterns are applied in the order as specified in the ta-
127 # ble, until a pattern is found that matches the search
128 # string.
129 #
130 # Results are the same as with indexed file lookups, with
131 # the additional feature that parenthesized substrings from
132 # the pattern can be interpolated as $1, $2 and so on.
133 #
134 # TCP-BASED TABLES
135 # This section describes how the table lookups change when
136 # lookups are directed to a TCP-based server. For a descrip-
137 # tion of the TCP client/server lookup protocol, see tcp_ta-
138 # ble(5). This feature is not available up to and including
139 # Postfix version 2.4.
140 #
141 # Each lookup operation uses the entire address once. Thus,
142 # user@domain mail addresses are not broken up into their
143 # user and @domain constituent parts, nor is user+foo broken
144 # up into user and foo.
145 #
146 # Results are the same as with indexed file lookups.
147 #
148 # EXAMPLE
149 # The following shows a generic mapping with an indexed
150 # file. When mail is sent to a remote host via SMTP, this
151 # replaces his@localdomain.local by his ISP mail address,
152 # replaces her@localdomain.local by her ISP mail address,
153 # and replaces other local addresses by his ISP account,
154 # with an address extension of +local (this example assumes
155 # that the ISP supports "+" style address extensions).
156 #
157 # /etc/postfix/main.cf:
158 # smtp_generic_maps = hash:/etc/postfix/generic
159 #
160 # /etc/postfix/generic:
161 # his@localdomain.local hisaccount@hisisp.example
162 # her@localdomain.local heraccount@herisp.example
163 # @localdomain.local hisaccount+local@hisisp.example
164 #
165 # Execute the command "postmap /etc/postfix/generic" when-
166 # ever the table is changed. Instead of hash, some systems
167 # use dbm database files. To find out what tables your sys-
168 # tem supports use the command "postconf -m".
169 #
170 # BUGS
171 # The table format does not understand quoting conventions.
172 #
173 # CONFIGURATION PARAMETERS
174 # The following main.cf parameters are especially relevant.
175 # The text below provides only a parameter summary. See
176 # postconf(5) for more details including examples.
177 #
178 # smtp_generic_maps
179 # Address mapping lookup table for envelope and
180 # header sender and recipient addresses while deliv-
181 # ering mail via SMTP.
182 #
183 # propagate_unmatched_extensions
184 # A list of address rewriting or forwarding mecha-
185 # nisms that propagate an address extension from the
186 # original address to the result. Specify zero or
187 # more of canonical, virtual, alias, forward,
188 # include, or generic.
189 #
190 # Other parameters of interest:
191 #
192 # inet_interfaces
193 # The network interface addresses that this system
194 # receives mail on. You need to stop and start Post-
195 # fix when this parameter changes.
196 #
197 # proxy_interfaces
198 # Other interfaces that this machine receives mail on
199 # by way of a proxy agent or network address transla-
200 # tor.
201 #
202 # mydestination
203 # List of domains that this mail system considers
204 # local.
205 #
206 # myorigin
207 # The domain that is appended to locally-posted mail.
208 #
209 # owner_request_special
210 # Give special treatment to owner-xxx and xxx-request
211 # addresses.
212 #
213 # SEE ALSO
214 # postmap(1), Postfix lookup table manager
215 # postconf(5), configuration parameters
216 # smtp(8), Postfix SMTP client
217 #
218 # README FILES
219 # Use "postconf readme_directory" or "postconf html_direc-
220 # tory" to locate this information.
221 # ADDRESS_REWRITING_README, address rewriting guide
222 # DATABASE_README, Postfix lookup table overview
223 # STANDARD_CONFIGURATION_README, configuration examples
224 #
225 # LICENSE
226 # The Secure Mailer license must be distributed with this
227 # software.
228 #
229 # HISTORY
230 # A genericstable feature appears in the Sendmail MTA.
231 #
232 # This feature is available in Postfix 2.2 and later.
233 #
234 # AUTHOR(S)
235 # Wietse Venema
236 # IBM T.J. Watson Research
237 # P.O. Box 704
238 # Yorktown Heights, NY 10598, USA
239 #
240 # GENERIC(5)