Expand PMF_FN_* macros.
[netbsd-mini2440.git] / external / ibm-public / postfix / dist / html / oqmgr.8.html
blob589beee042aa8c6ae6488272e56fa8f77109fe42
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 - oqmgr(8) </title>
6 </head> <body> <pre>
7 OQMGR(8) OQMGR(8)
9 <b>NAME</b>
10 oqmgr - old Postfix queue manager
12 <b>SYNOPSIS</b>
13 <b>oqmgr</b> [generic Postfix daemon options]
15 <b>DESCRIPTION</b>
16 The <a href="qmgr.8.html"><b>oqmgr</b>(8)</a> daemon awaits the arrival of incoming mail
17 and arranges for its delivery via Postfix delivery pro-
18 cesses. The actual mail routing strategy is delegated to
19 the <a href="trivial-rewrite.8.html"><b>trivial-rewrite</b>(8)</a> daemon. This program expects to be
20 run from the <a href="master.8.html"><b>master</b>(8)</a> process manager.
22 Mail addressed to the local <b>double-bounce</b> address is
23 logged and discarded. This stops potential loops caused
24 by undeliverable bounce notifications.
26 <b>MAIL QUEUES</b>
27 The <a href="qmgr.8.html"><b>oqmgr</b>(8)</a> daemon maintains the following queues:
29 <b>incoming</b>
30 Inbound mail from the network, or mail picked up by
31 the local <a href="pickup.8.html"><b>pickup</b>(8)</a> agent from the <b>maildrop</b> direc-
32 tory.
34 <b>active</b> Messages that the queue manager has opened for
35 delivery. Only a limited number of messages is
36 allowed to enter the <b>active</b> queue (leaky bucket
37 strategy, for a fixed delivery rate).
39 <b>deferred</b>
40 Mail that could not be delivered upon the first
41 attempt. The queue manager implements exponential
42 backoff by doubling the time between delivery
43 attempts.
45 <b>corrupt</b>
46 Unreadable or damaged queue files are moved here
47 for inspection.
49 <b>hold</b> Messages that are kept "on hold" are kept here
50 until someone sets them free.
52 <b>DELIVERY STATUS REPORTS</b>
53 The <a href="qmgr.8.html"><b>oqmgr</b>(8)</a> daemon keeps an eye on per-message delivery
54 status reports in the following directories. Each status
55 report file has the same name as the corresponding message
56 file:
58 <b>bounce</b> Per-recipient status information about why mail is
59 bounced. These files are maintained by the
60 <a href="bounce.8.html"><b>bounce</b>(8)</a> daemon.
62 <b>defer</b> Per-recipient status information about why mail is
63 delayed. These files are maintained by the
64 <a href="defer.8.html"><b>defer</b>(8)</a> daemon.
66 <b>trace</b> Per-recipient status information as requested with
67 the Postfix "<b>sendmail -v</b>" or "<b>sendmail -bv</b>" com-
68 mand. These files are maintained by the <a href="trace.8.html"><b>trace</b>(8)</a>
69 daemon.
71 The <a href="qmgr.8.html"><b>oqmgr</b>(8)</a> daemon is responsible for asking the
72 <a href="bounce.8.html"><b>bounce</b>(8)</a>, <a href="defer.8.html"><b>defer</b>(8)</a> or <a href="trace.8.html"><b>trace</b>(8)</a> daemons to send delivery
73 reports.
75 <b>STRATEGIES</b>
76 The queue manager implements a variety of strategies for
77 either opening queue files (input) or for message delivery
78 (output).
80 <b>leaky bucket</b>
81 This strategy limits the number of messages in the
82 <b>active</b> queue and prevents the queue manager from
83 running out of memory under heavy load.
85 <b>fairness</b>
86 When the <b>active</b> queue has room, the queue manager
87 takes one message from the <a href="QSHAPE_README.html#incoming_queue"><b>incoming</b> queue</a> and one
88 from the <b>deferred</b> queue. This prevents a large mail
89 backlog from blocking the delivery of new mail.
91 <b>slow start</b>
92 This strategy eliminates "thundering herd" problems
93 by slowly adjusting the number of parallel deliver-
94 ies to the same destination.
96 <b>round robin</b>
97 The queue manager sorts delivery requests by desti-
98 nation. Round-robin selection prevents one desti-
99 nation from dominating deliveries to other destina-
100 tions.
102 <b>exponential backoff</b>
103 Mail that cannot be delivered upon the first
104 attempt is deferred. The time interval between
105 delivery attempts is doubled after each attempt.
107 <b>destination status cache</b>
108 The queue manager avoids unnecessary delivery
109 attempts by maintaining a short-term, in-memory
110 list of unreachable destinations.
112 <b>TRIGGERS</b>
113 On an idle system, the queue manager waits for the arrival
114 of trigger events, or it waits for a timer to go off. A
115 trigger is a one-byte message. Depending on the message
116 received, the queue manager performs one of the following
117 actions (the message is followed by the symbolic constant
118 used internally by the software):
120 <b>D (QMGR_REQ_SCAN_DEFERRED)</b>
121 Start a <a href="QSHAPE_README.html#deferred_queue">deferred queue</a> scan. If a deferred queue
122 scan is already in progress, that scan will be
123 restarted as soon as it finishes.
125 <b>I (QMGR_REQ_SCAN_INCOMING)</b>
126 Start an <a href="QSHAPE_README.html#incoming_queue">incoming queue</a> scan. If an incoming queue
127 scan is already in progress, that scan will be
128 restarted as soon as it finishes.
130 <b>A (QMGR_REQ_SCAN_ALL)</b>
131 Ignore <a href="QSHAPE_README.html#deferred_queue">deferred queue</a> file time stamps. The request
132 affects the next <a href="QSHAPE_README.html#deferred_queue">deferred queue</a> scan.
134 <b>F (QMGR_REQ_FLUSH_DEAD)</b>
135 Purge all information about dead transports and
136 destinations.
138 <b>W (TRIGGER_REQ_WAKEUP)</b>
139 Wakeup call, This is used by the master server to
140 instantiate servers that should not go away for-
141 ever. The action is to start an <a href="QSHAPE_README.html#incoming_queue">incoming queue</a>
142 scan.
144 The <a href="qmgr.8.html"><b>oqmgr</b>(8)</a> daemon reads an entire buffer worth of trig-
145 gers. Multiple identical trigger requests are collapsed
146 into one, and trigger requests are sorted so that <b>A</b> and <b>F</b>
147 precede <b>D</b> and <b>I</b>. Thus, in order to force a <a href="QSHAPE_README.html#deferred_queue">deferred queue</a>
148 run, one would request <b>A F D</b>; in order to notify the queue
149 manager of the arrival of new mail one would request <b>I</b>.
151 <b>STANDARDS</b>
152 <a href="http://tools.ietf.org/html/rfc3463">RFC 3463</a> (Enhanced status codes)
153 <a href="http://tools.ietf.org/html/rfc3464">RFC 3464</a> (Delivery status notifications)
155 <b>SECURITY</b>
156 The <a href="qmgr.8.html"><b>oqmgr</b>(8)</a> daemon is not security sensitive. It reads
157 single-character messages from untrusted local users, and
158 thus may be susceptible to denial of service attacks. The
159 <a href="qmgr.8.html"><b>oqmgr</b>(8)</a> daemon does not talk to the outside world, and it
160 can be run at fixed low privilege in a chrooted environ-
161 ment.
163 <b>DIAGNOSTICS</b>
164 Problems and transactions are logged to the <b>syslog</b>(8) dae-
165 mon. Corrupted message files are saved to the <b>corrupt</b>
166 queue for further inspection.
168 Depending on the setting of the <b><a href="postconf.5.html#notify_classes">notify_classes</a></b> parameter,
169 the postmaster is notified of bounces and of other trou-
170 ble.
172 <b>BUGS</b>
173 A single queue manager process has to compete for disk
174 access with multiple front-end processes such as
175 <a href="cleanup.8.html"><b>cleanup</b>(8)</a>. A sudden burst of inbound mail can negatively
176 impact outbound delivery rates.
178 <b>CONFIGURATION PARAMETERS</b>
179 Changes to <a href="postconf.5.html"><b>main.cf</b></a> are not picked up automatically, as
180 <a href="qmgr.8.html"><b>oqmgr</b>(8)</a> is a persistent process. Use the command "<b>postfix</b>
181 <b>reload</b>" after a configuration change.
183 The text below provides only a parameter summary. See
184 <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including examples.
186 In the text below, <i>transport</i> is the first field in a <b>mas-</b>
187 <b>ter.cf</b> entry.
189 <b>COMPATIBILITY CONTROLS</b>
190 Available before Postfix version 2.5:
192 <b><a href="postconf.5.html#allow_min_user">allow_min_user</a> (no)</b>
193 Allow a sender or recipient address to have `-' as
194 the first character.
196 <b>ACTIVE QUEUE CONTROLS</b>
197 <b><a href="postconf.5.html#qmgr_clog_warn_time">qmgr_clog_warn_time</a> (300s)</b>
198 The minimal delay between warnings that a specific
199 destination is clogging up the Postfix active
200 queue.
202 <b><a href="postconf.5.html#qmgr_message_active_limit">qmgr_message_active_limit</a> (20000)</b>
203 The maximal number of messages in the <a href="QSHAPE_README.html#active_queue">active queue</a>.
205 <b><a href="postconf.5.html#qmgr_message_recipient_limit">qmgr_message_recipient_limit</a> (20000)</b>
206 The maximal number of recipients held in memory by
207 the Postfix queue manager, and the maximal size of
208 the size of the short-term, in-memory "dead" desti-
209 nation status cache.
211 <b>DELIVERY CONCURRENCY CONTROLS</b>
212 <b><a href="postconf.5.html#qmgr_fudge_factor">qmgr_fudge_factor</a> (100)</b>
213 Obsolete feature: the percentage of delivery
214 resources that a busy mail system will use up for
215 delivery of a large mailing list message.
217 <b><a href="postconf.5.html#initial_destination_concurrency">initial_destination_concurrency</a> (5)</b>
218 The initial per-destination concurrency level for
219 parallel delivery to the same destination.
221 <b><a href="postconf.5.html#default_destination_concurrency_limit">default_destination_concurrency_limit</a> (20)</b>
222 The default maximal number of parallel deliveries
223 to the same destination.
225 <b><a href="postconf.5.html#transport_destination_concurrency_limit"><i>transport</i>_destination_concurrency_limit</a> ($<a href="postconf.5.html#default_destination_concurrency_limit">default_destina</a>-</b>
226 <b><a href="postconf.5.html#default_destination_concurrency_limit">tion_concurrency_limit</a>)</b>
227 Idem, for delivery via the named message <i>transport</i>.
229 Available in Postfix version 2.5 and later:
231 <b><a href="postconf.5.html#transport_initial_destination_concurrency"><i>transport</i>_initial_destination_concurrency</a> ($<a href="postconf.5.html#initial_destination_concurrency">initial_desti</a>-</b>
232 <b><a href="postconf.5.html#initial_destination_concurrency">nation_concurrency</a>)</b>
233 Initial concurrency for delivery via the named mes-
234 sage <i>transport</i>.
236 <b><a href="postconf.5.html#default_destination_concurrency_failed_cohort_limit">default_destination_concurrency_failed_cohort_limit</a> (1)</b>
237 How many pseudo-cohorts must suffer connection or
238 handshake failure before a specific destination is
239 considered unavailable (and further delivery is
240 suspended).
242 <b><a href="postconf.5.html#transport_destination_concurrency_failed_cohort_limit"><i>transport</i>_destination_concurrency_failed_cohort_limit</a></b>
243 <b>($<a href="postconf.5.html#default_destination_concurrency_failed_cohort_limit">default_destination_concurrency_failed_cohort_limit</a>)</b>
244 Idem, for delivery via the named message <i>transport</i>.
246 <b><a href="postconf.5.html#default_destination_concurrency_negative_feedback">default_destination_concurrency_negative_feedback</a> (1)</b>
247 The per-destination amount of delivery concurrency
248 negative feedback, after a delivery completes with
249 a connection or handshake failure.
251 <b><a href="postconf.5.html#transport_destination_concurrency_negative_feedback"><i>transport</i>_destination_concurrency_negative_feedback</a></b>
252 <b>($<a href="postconf.5.html#default_destination_concurrency_negative_feedback">default_destination_concurrency_negative_feedback</a>)</b>
253 Idem, for delivery via the named message <i>transport</i>.
255 <b><a href="postconf.5.html#default_destination_concurrency_positive_feedback">default_destination_concurrency_positive_feedback</a> (1)</b>
256 The per-destination amount of delivery concurrency
257 positive feedback, after a delivery completes with-
258 out connection or handshake failure.
260 <b><a href="postconf.5.html#transport_destination_concurrency_positive_feedback"><i>transport</i>_destination_concurrency_positive_feedback</a></b>
261 <b>($<a href="postconf.5.html#default_destination_concurrency_positive_feedback">default_destination_concurrency_positive_feedback</a>)</b>
262 Idem, for delivery via the named message <i>transport</i>.
264 <b><a href="postconf.5.html#destination_concurrency_feedback_debug">destination_concurrency_feedback_debug</a> (no)</b>
265 Make the queue manager's feedback algorithm verbose
266 for performance analysis purposes.
268 <b>RECIPIENT SCHEDULING CONTROLS</b>
269 <b><a href="postconf.5.html#default_destination_recipient_limit">default_destination_recipient_limit</a> (50)</b>
270 The default maximal number of recipients per mes-
271 sage delivery.
273 <b><a href="postconf.5.html#transport_destination_recipient_limit"><i>transport</i>_destination_recipient_limit</a></b>
274 Idem, for delivery via the named message <i>transport</i>.
276 <b>OTHER RESOURCE AND RATE CONTROLS</b>
277 <b><a href="postconf.5.html#minimal_backoff_time">minimal_backoff_time</a> (300s)</b>
278 The minimal time between attempts to deliver a
279 deferred message; prior to Postfix 2.4 the default
280 value was 1000s.
282 <b><a href="postconf.5.html#maximal_backoff_time">maximal_backoff_time</a> (4000s)</b>
283 The maximal time between attempts to deliver a
284 deferred message.
286 <b><a href="postconf.5.html#maximal_queue_lifetime">maximal_queue_lifetime</a> (5d)</b>
287 The maximal time a message is queued before it is
288 sent back as undeliverable.
290 <b><a href="postconf.5.html#queue_run_delay">queue_run_delay</a> (300s)</b>
291 The time between <a href="QSHAPE_README.html#deferred_queue">deferred queue</a> scans by the queue
292 manager; prior to Postfix 2.4 the default value was
293 1000s.
295 <b><a href="postconf.5.html#transport_retry_time">transport_retry_time</a> (60s)</b>
296 The time between attempts by the Postfix queue man-
297 ager to contact a malfunctioning message delivery
298 transport.
300 Available in Postfix version 2.1 and later:
302 <b><a href="postconf.5.html#bounce_queue_lifetime">bounce_queue_lifetime</a> (5d)</b>
303 The maximal time a bounce message is queued before
304 it is considered undeliverable.
306 Available in Postfix version 2.5 and later:
308 <b><a href="postconf.5.html#default_destination_rate_delay">default_destination_rate_delay</a> (0s)</b>
309 The default amount of delay that is inserted
310 between individual deliveries to the same destina-
311 tion; with per-destination recipient limit &gt; 1, a
312 destination is a domain, otherwise it is a recipi-
313 ent.
315 <b><a href="postconf.5.html#transport_destination_rate_delay"><i>transport</i>_destination_rate_delay</a> $<a href="postconf.5.html#default_destination_rate_delay">default_destina</a>-</b>
316 <b><a href="postconf.5.html#default_destination_rate_delay">tion_rate_delay</a></b>
317 Idem, for delivery via the named message <i>transport</i>.
319 <b>MISCELLANEOUS CONTROLS</b>
320 <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
321 The default location of the Postfix <a href="postconf.5.html">main.cf</a> and
322 <a href="master.5.html">master.cf</a> configuration files.
324 <b><a href="postconf.5.html#defer_transports">defer_transports</a> (empty)</b>
325 The names of message delivery transports that
326 should not deliver mail unless someone issues
327 "<b>sendmail -q</b>" or equivalent.
329 <b><a href="postconf.5.html#delay_logging_resolution_limit">delay_logging_resolution_limit</a> (2)</b>
330 The maximal number of digits after the decimal
331 point when logging sub-second delay values.
333 <b><a href="postconf.5.html#helpful_warnings">helpful_warnings</a> (yes)</b>
334 Log warnings about problematic configuration set-
335 tings, and provide helpful suggestions.
337 <b><a href="postconf.5.html#ipc_timeout">ipc_timeout</a> (3600s)</b>
338 The time limit for sending or receiving information
339 over an internal communication channel.
341 <b><a href="postconf.5.html#process_id">process_id</a> (read-only)</b>
342 The process ID of a Postfix command or daemon
343 process.
345 <b><a href="postconf.5.html#process_name">process_name</a> (read-only)</b>
346 The process name of a Postfix command or daemon
347 process.
349 <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
350 The location of the Postfix top-level queue direc-
351 tory.
353 <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
354 The syslog facility of Postfix logging.
356 <b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b>
357 The mail system name that is prepended to the
358 process name in syslog records, so that "smtpd"
359 becomes, for example, "postfix/smtpd".
361 <b>FILES</b>
362 /var/spool/postfix/incoming, <a href="QSHAPE_README.html#incoming_queue">incoming queue</a>
363 /var/spool/postfix/active, <a href="QSHAPE_README.html#active_queue">active queue</a>
364 /var/spool/postfix/deferred, <a href="QSHAPE_README.html#deferred_queue">deferred queue</a>
365 /var/spool/postfix/bounce, non-delivery status
366 /var/spool/postfix/defer, non-delivery status
367 /var/spool/postfix/trace, delivery status
369 <b>SEE ALSO</b>
370 <a href="trivial-rewrite.8.html">trivial-rewrite(8)</a>, address routing
371 <a href="bounce.8.html">bounce(8)</a>, delivery status reports
372 <a href="postconf.5.html">postconf(5)</a>, configuration parameters
373 <a href="master.5.html">master(5)</a>, generic daemon options
374 <a href="master.8.html">master(8)</a>, process manager
375 syslogd(8), system logging
377 <b>README FILES</b>
378 <a href="QSHAPE_README.html">QSHAPE_README</a>, Postfix queue analysis
380 <b>LICENSE</b>
381 The Secure Mailer license must be distributed with this
382 software.
384 <b>AUTHOR(S)</b>
385 Wietse Venema
386 IBM T.J. Watson Research
387 P.O. Box 704
388 Yorktown Heights, NY 10598, USA
390 OQMGR(8)
391 </pre> </body> </html>