autoupdate
[postfix-master.git] / postfix-master / trivial-rewrite.8.html
blob6da7aced56749467ed476fb914daced52c1cffd9
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 - trivial-rewrite(8) </title>
6 </head> <body> <pre>
7 TRIVIAL-REWRITE(8) TRIVIAL-REWRITE(8)
9 <b>NAME</b>
10 trivial-rewrite - Postfix address rewriting and resolving
11 daemon
13 <b>SYNOPSIS</b>
14 <b>trivial-rewrite</b> [generic Postfix daemon options]
16 <b>DESCRIPTION</b>
17 The <a href="trivial-rewrite.8.html"><b>trivial-rewrite</b>(8)</a> daemon processes three types of
18 client service requests:
20 <b>rewrite</b> <i>context address</i>
21 Rewrite an address to standard form, according to
22 the address rewriting context:
24 <b>local</b> Append the domain names specified with <b>$<a href="postconf.5.html#myorigin">myo</a>-</b>
25 <b><a href="postconf.5.html#myorigin">rigin</a></b> or <b>$<a href="postconf.5.html#mydomain">mydomain</a></b> to incomplete addresses;
26 do <b><a href="postconf.5.html#swap_bangpath">swap_bangpath</a></b> and <b><a href="postconf.5.html#allow_percent_hack">allow_percent_hack</a></b> pro-
27 cessing as described below, and strip source
28 routed addresses (<i>@site,@site:user@domain</i>)
29 to <i>user@domain</i> form.
31 <b>remote</b> Append the domain name specified with
32 <b>$<a href="postconf.5.html#remote_header_rewrite_domain">remote_header_rewrite_domain</a></b> to incomplete
33 addresses. Otherwise the result is identical
34 to that of the <b>local</b> address rewriting con-
35 text. This prevents Postfix from appending
36 the <a href="ADDRESS_CLASS_README.html#local_domain_class">local domain</a> to spam from poorly written
37 remote clients.
39 <b>resolve</b> <i>sender address</i>
40 Resolve the address to a (<i>transport</i>, <i>nexthop</i>,
41 <i>recipient</i>, <i>flags</i>) quadruple. The meaning of the
42 results is as follows:
44 <i>transport</i>
45 The delivery agent to use. This is the first
46 field of an entry in the <a href="master.5.html"><b>master.cf</b></a> file.
48 <i>nexthop</i>
49 The host to send to and optional delivery
50 method information.
52 <i>recipient</i>
53 The envelope recipient address that is
54 passed on to <i>nexthop</i>.
56 <i>flags</i> The address class, whether the address
57 requires relaying, whether the address has
58 problems, and whether the request failed.
60 <b>verify</b> <i>sender address</i>
61 Resolve the address for address verification pur-
62 poses.
64 <b>SERVER PROCESS MANAGEMENT</b>
65 The <a href="trivial-rewrite.8.html"><b>trivial-rewrite</b>(8)</a> servers run under control by the
66 Postfix master server. Each server can handle multiple
67 simultaneous connections. When all servers are busy while
68 a client connects, the master creates a new server
69 process, provided that the trivial-rewrite server process
70 limit is not exceeded. Each trivial-rewrite server termi-
71 nates after serving at least <b>$<a href="postconf.5.html#max_use">max_use</a></b> clients of after
72 <b>$<a href="postconf.5.html#max_idle">max_idle</a></b> seconds of idle time.
74 <b>STANDARDS</b>
75 None. The command does not interact with the outside
76 world.
78 <b>SECURITY</b>
79 The <a href="trivial-rewrite.8.html"><b>trivial-rewrite</b>(8)</a> daemon is not security sensitive.
80 By default, this daemon does not talk to remote or local
81 users. It can run at a fixed low privilege in a chrooted
82 environment.
84 <b>DIAGNOSTICS</b>
85 Problems and transactions are logged to <b>syslogd</b>(8).
87 <b>CONFIGURATION PARAMETERS</b>
88 On busy mail systems a long time may pass before a <a href="postconf.5.html"><b>main.cf</b></a>
89 change affecting <a href="trivial-rewrite.8.html"><b>trivial-rewrite</b>(8)</a> is picked up. Use the
90 command "<b>postfix reload</b>" to speed up a change.
92 The text below provides only a parameter summary. See
93 <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including examples.
95 <b>COMPATIBILITY CONTROLS</b>
96 <b><a href="postconf.5.html#resolve_dequoted_address">resolve_dequoted_address</a> (yes)</b>
97 Resolve a recipient address safely instead of cor-
98 rectly, by looking inside quotes.
100 <b><a href="postconf.5.html#resolve_null_domain">resolve_null_domain</a> (no)</b>
101 Resolve an address that ends in the "@" null domain
102 as if the local hostname were specified, instead of
103 rejecting the address as invalid.
105 <b><a href="postconf.5.html#resolve_numeric_domain">resolve_numeric_domain</a> (no)</b>
106 Resolve "user@ipaddress" as "user@[ipaddress]",
107 instead of rejecting the address as invalid.
109 Available with Postfix version 2.5 and later:
111 <b><a href="postconf.5.html#allow_min_user">allow_min_user</a> (no)</b>
112 Allow a sender or recipient address to have `-' as
113 the first character.
115 <b>ADDRESS REWRITING CONTROLS</b>
116 <b><a href="postconf.5.html#myorigin">myorigin</a> ($<a href="postconf.5.html#myhostname">myhostname</a>)</b>
117 The domain name that locally-posted mail appears to
118 come from, and that locally posted mail is deliv-
119 ered to.
121 <b><a href="postconf.5.html#allow_percent_hack">allow_percent_hack</a> (yes)</b>
122 Enable the rewriting of the form "user%domain" to
123 "user@domain".
125 <b><a href="postconf.5.html#append_at_myorigin">append_at_myorigin</a> (yes)</b>
126 With locally submitted mail, append the string
127 "@$<a href="postconf.5.html#myorigin">myorigin</a>" to mail addresses without domain
128 information.
130 <b><a href="postconf.5.html#append_dot_mydomain">append_dot_mydomain</a> (yes)</b>
131 With locally submitted mail, append the string
132 ".$<a href="postconf.5.html#mydomain">mydomain</a>" to addresses that have no ".domain"
133 information.
135 <b><a href="postconf.5.html#recipient_delimiter">recipient_delimiter</a> (empty)</b>
136 The separator between user names and address exten-
137 sions (user+foo).
139 <b><a href="postconf.5.html#swap_bangpath">swap_bangpath</a> (yes)</b>
140 Enable the rewriting of "site!user" into
141 "user@site".
143 Available in Postfix 2.2 and later:
145 <b><a href="postconf.5.html#remote_header_rewrite_domain">remote_header_rewrite_domain</a> (empty)</b>
146 Don't rewrite message headers from remote clients
147 at all when this parameter is empty; otherwise, re-
148 write message headers and append the specified
149 domain name to incomplete addresses.
151 <b>ROUTING CONTROLS</b>
152 The following is applicable to Postfix version 2.0 and
153 later. Earlier versions do not have support for: <a href="postconf.5.html#virtual_transport">vir</a>-
154 <a href="postconf.5.html#virtual_transport">tual_transport</a>, <a href="postconf.5.html#relay_transport">relay_transport</a>, <a href="postconf.5.html#virtual_alias_domains">virtual_alias_domains</a>,
155 <a href="postconf.5.html#virtual_mailbox_domains">virtual_mailbox_domains</a> or <a href="postconf.5.html#proxy_interfaces">proxy_interfaces</a>.
157 <b><a href="postconf.5.html#local_transport">local_transport</a> (<a href="local.8.html">local</a>:$<a href="postconf.5.html#myhostname">myhostname</a>)</b>
158 The default mail delivery transport and next-hop
159 destination for final delivery to domains listed
160 with <a href="postconf.5.html#mydestination">mydestination</a>, and for [ipaddress] destina-
161 tions that match $<a href="postconf.5.html#inet_interfaces">inet_interfaces</a> or $<a href="postconf.5.html#proxy_interfaces">proxy_inter</a>-
162 <a href="postconf.5.html#proxy_interfaces">faces</a>.
164 <b><a href="postconf.5.html#virtual_transport">virtual_transport</a> (virtual)</b>
165 The default mail delivery transport and next-hop
166 destination for final delivery to domains listed
167 with $<a href="postconf.5.html#virtual_mailbox_domains">virtual_mailbox_domains</a>.
169 <b><a href="postconf.5.html#relay_transport">relay_transport</a> (relay)</b>
170 The default mail delivery transport and next-hop
171 destination for remote delivery to domains listed
172 with $<a href="postconf.5.html#relay_domains">relay_domains</a>.
174 <b><a href="postconf.5.html#default_transport">default_transport</a> (smtp)</b>
175 The default mail delivery transport and next-hop
176 destination for destinations that do not match
177 $<a href="postconf.5.html#mydestination">mydestination</a>, $<a href="postconf.5.html#inet_interfaces">inet_interfaces</a>, $<a href="postconf.5.html#proxy_interfaces">proxy_inter</a>-
178 <a href="postconf.5.html#proxy_interfaces">faces</a>, $<a href="postconf.5.html#virtual_alias_domains">virtual_alias_domains</a>, $<a href="postconf.5.html#virtual_mailbox_domains">virtual_mail-
179 box_domains</a>, or $<a href="postconf.5.html#relay_domains">relay_domains</a>.
181 <b><a href="postconf.5.html#parent_domain_matches_subdomains">parent_domain_matches_subdomains</a> (see 'postconf -d' out-</b>
182 <b>put)</b>
183 What Postfix features match subdomains of
184 "domain.tld" automatically, instead of requiring an
185 explicit ".domain.tld" pattern.
187 <b><a href="postconf.5.html#relayhost">relayhost</a> (empty)</b>
188 The next-hop destination of non-local mail; over-
189 rides non-<a href="ADDRESS_CLASS_README.html#local_domain_class">local domains</a> in recipient addresses.
191 <b><a href="postconf.5.html#transport_maps">transport_maps</a> (empty)</b>
192 Optional lookup tables with mappings from recipient
193 address to (message delivery transport, next-hop
194 destination).
196 Available in Postfix version 2.3 and later:
198 <b><a href="postconf.5.html#sender_dependent_relayhost_maps">sender_dependent_relayhost_maps</a> (empty)</b>
199 A sender-dependent override for the global <a href="postconf.5.html#relayhost">relay</a>-
200 <a href="postconf.5.html#relayhost">host</a> parameter setting.
202 Available in Postfix version 2.5 and later:
204 <b><a href="postconf.5.html#empty_address_relayhost_maps_lookup_key">empty_address_relayhost_maps_lookup_key</a> (</b>&lt;&gt;<b>)</b>
205 The <a href="postconf.5.html#sender_dependent_relayhost_maps">sender_dependent_relayhost_maps</a> search string
206 that will be used instead of the null sender
207 address.
209 Available in Postfix version 2.7 and later:
211 <b><a href="postconf.5.html#empty_address_default_transport_maps_lookup_key">empty_address_default_transport_maps_lookup_key</a> (</b>&lt;&gt;<b>)</b>
212 The <a href="postconf.5.html#sender_dependent_default_transport_maps">sender_dependent_default_transport_maps</a> search
213 string that will be used instead of the null sender
214 address.
216 <b><a href="postconf.5.html#sender_dependent_default_transport_maps">sender_dependent_default_transport_maps</a> (empty)</b>
217 A sender-dependent override for the global
218 <a href="postconf.5.html#default_transport">default_transport</a> parameter setting.
220 <b>ADDRESS VERIFICATION CONTROLS</b>
221 Postfix version 2.1 introduces sender and recipient
222 address verification. This feature is implemented by
223 sending probe email messages that are not actually deliv-
224 ered. By default, address verification probes use the
225 same route as regular mail. To override specific aspects
226 of message routing for address verification probes, spec-
227 ify one or more of the following:
229 <b><a href="postconf.5.html#address_verify_local_transport">address_verify_local_transport</a> ($<a href="postconf.5.html#local_transport">local_transport</a>)</b>
230 Overrides the <a href="postconf.5.html#local_transport">local_transport</a> parameter setting for
231 address verification probes.
233 <b><a href="postconf.5.html#address_verify_virtual_transport">address_verify_virtual_transport</a> ($<a href="postconf.5.html#virtual_transport">virtual_transport</a>)</b>
234 Overrides the <a href="postconf.5.html#virtual_transport">virtual_transport</a> parameter setting
235 for address verification probes.
237 <b><a href="postconf.5.html#address_verify_relay_transport">address_verify_relay_transport</a> ($<a href="postconf.5.html#relay_transport">relay_transport</a>)</b>
238 Overrides the <a href="postconf.5.html#relay_transport">relay_transport</a> parameter setting for
239 address verification probes.
241 <b><a href="postconf.5.html#address_verify_default_transport">address_verify_default_transport</a> ($<a href="postconf.5.html#default_transport">default_transport</a>)</b>
242 Overrides the <a href="postconf.5.html#default_transport">default_transport</a> parameter setting
243 for address verification probes.
245 <b><a href="postconf.5.html#address_verify_relayhost">address_verify_relayhost</a> ($<a href="postconf.5.html#relayhost">relayhost</a>)</b>
246 Overrides the <a href="postconf.5.html#relayhost">relayhost</a> parameter setting for
247 address verification probes.
249 <b><a href="postconf.5.html#address_verify_transport_maps">address_verify_transport_maps</a> ($<a href="postconf.5.html#transport_maps">transport_maps</a>)</b>
250 Overrides the <a href="postconf.5.html#transport_maps">transport_maps</a> parameter setting for
251 address verification probes.
253 Available in Postfix version 2.3 and later:
255 <b><a href="postconf.5.html#address_verify_sender_dependent_relayhost_maps">address_verify_sender_dependent_relayhost_maps</a></b>
256 <b>($<a href="postconf.5.html#sender_dependent_relayhost_maps">sender_dependent_relayhost_maps</a>)</b>
257 Overrides the <a href="postconf.5.html#sender_dependent_relayhost_maps">sender_dependent_relayhost_maps</a>
258 parameter setting for address verification probes.
260 Available in Postfix version 2.7 and later:
262 <b><a href="postconf.5.html#address_verify_sender_dependent_default_transport_maps">address_verify_sender_dependent_default_transport_maps</a></b>
263 <b>($<a href="postconf.5.html#sender_dependent_default_transport_maps">sender_dependent_default_transport_maps</a>)</b>
264 Overrides the <a href="postconf.5.html#sender_dependent_default_transport_maps">sender_dependent_default_trans</a>-
265 <a href="postconf.5.html#sender_dependent_default_transport_maps">port_maps</a> parameter setting for address verifica-
266 tion probes.
268 <b>MISCELLANEOUS CONTROLS</b>
269 <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
270 The default location of the Postfix <a href="postconf.5.html">main.cf</a> and
271 <a href="master.5.html">master.cf</a> configuration files.
273 <b><a href="postconf.5.html#daemon_timeout">daemon_timeout</a> (18000s)</b>
274 How much time a Postfix daemon process may take to
275 handle a request before it is terminated by a
276 built-in watchdog timer.
278 <b><a href="postconf.5.html#empty_address_recipient">empty_address_recipient</a> (MAILER-DAEMON)</b>
279 The recipient of mail addressed to the null
280 address.
282 <b><a href="postconf.5.html#ipc_timeout">ipc_timeout</a> (3600s)</b>
283 The time limit for sending or receiving information
284 over an internal communication channel.
286 <b><a href="postconf.5.html#max_idle">max_idle</a> (100s)</b>
287 The maximum amount of time that an idle Postfix
288 daemon process waits for an incoming connection
289 before terminating voluntarily.
291 <b><a href="postconf.5.html#max_use">max_use</a> (100)</b>
292 The maximal number of incoming connections that a
293 Postfix daemon process will service before termi-
294 nating voluntarily.
296 <b><a href="postconf.5.html#relocated_maps">relocated_maps</a> (empty)</b>
297 Optional lookup tables with new contact information
298 for users or domains that no longer exist.
300 <b><a href="postconf.5.html#process_id">process_id</a> (read-only)</b>
301 The process ID of a Postfix command or daemon
302 process.
304 <b><a href="postconf.5.html#process_name">process_name</a> (read-only)</b>
305 The process name of a Postfix command or daemon
306 process.
308 <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
309 The location of the Postfix top-level queue direc-
310 tory.
312 <b><a href="postconf.5.html#show_user_unknown_table_name">show_user_unknown_table_name</a> (yes)</b>
313 Display the name of the recipient table in the
314 "User unknown" responses.
316 <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
317 The syslog facility of Postfix logging.
319 <b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b>
320 The mail system name that is prepended to the
321 process name in syslog records, so that "smtpd"
322 becomes, for example, "postfix/smtpd".
324 Available in Postfix version 2.0 and later:
326 <b><a href="postconf.5.html#helpful_warnings">helpful_warnings</a> (yes)</b>
327 Log warnings about problematic configuration set-
328 tings, and provide helpful suggestions.
330 <b>SEE ALSO</b>
331 <a href="postconf.5.html">postconf(5)</a>, configuration parameters
332 <a href="transport.5.html">transport(5)</a>, transport table format
333 <a href="relocated.5.html">relocated(5)</a>, format of the "user has moved" table
334 <a href="master.8.html">master(8)</a>, process manager
335 syslogd(8), system logging
337 <b>README FILES</b>
338 <a href="ADDRESS_CLASS_README.html">ADDRESS_CLASS_README</a>, Postfix address classes howto
339 <a href="ADDRESS_VERIFICATION_README.html">ADDRESS_VERIFICATION_README</a>, Postfix address verification
341 <b>LICENSE</b>
342 The Secure Mailer license must be distributed with this
343 software.
345 <b>AUTHOR(S)</b>
346 Wietse Venema
347 IBM T.J. Watson Research
348 P.O. Box 704
349 Yorktown Heights, NY 10598, USA
351 TRIVIAL-REWRITE(8)
352 </pre> </body> </html>