xref: /netbsd-src/external/ibm-public/postfix/dist/html/flush.8.html (revision 059c16a85b0b39d60ad6d18f53c09510815afa2b)
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=utf-8">
5<link rel='stylesheet' type='text/css' href='postfix-doc.css'>
6<title> Postfix manual - flush(8) </title>
7</head> <body> <pre>
8FLUSH(8)                                                              FLUSH(8)
9
10<b>NAME</b>
11       flush - Postfix fast flush server
12
13<b>SYNOPSIS</b>
14       <b>flush</b> [generic Postfix daemon options]
15
16<b>DESCRIPTION</b>
17       The <a href="flush.8.html"><b>flush</b>(8)</a> server maintains a record of deferred mail by destination.
18       This information is used to improve the performance of  the  SMTP  <b>ETRN</b>
19       request,   and  of  its  command-line  equivalent,  "<b>sendmail  -qR</b>"  or
20       "<b>postqueue -f</b>".  This program expects to  be  run  from  the  <a href="master.8.html"><b>master</b>(8)</a>
21       process manager.
22
23       The record is implemented as a per-destination logfile with as contents
24       the queue IDs of deferred mail. A logfile is append-only, and is  trun-
25       cated  when  delivery is requested for the corresponding destination. A
26       destination is the part on the right-hand side of the right-most  <b>@</b>  in
27       an email address.
28
29       Per-destination  logfiles of deferred mail are maintained only for eli-
30       gible destinations. The list of eligible destinations is specified with
31       the  <b><a href="postconf.5.html#fast_flush_domains">fast_flush_domains</a></b>  configuration  parameter,  which  defaults  to
32       <b>$<a href="postconf.5.html#relay_domains">relay_domains</a></b>.
33
34       This server implements the following requests:
35
36       <b>add</b> <i>sitename queueid</i>
37              Inform the <a href="flush.8.html"><b>flush</b>(8)</a> server that the message with  the  specified
38              queue ID is queued for the specified destination.
39
40       <b>send_site</b> <i>sitename</i>
41              Request delivery of mail that is queued for the specified desti-
42              nation.
43
44       <b>send_file</b> <i>queueid</i>
45              Request delivery of the specified deferred message.
46
47       <b>refresh</b>
48              Refresh non-empty per-destination logfiles that were not read in
49              <b>$<a href="postconf.5.html#fast_flush_refresh_time">fast_flush_refresh_time</a></b> hours, by simulating send requests (see
50              above) for the corresponding destinations.
51
52              Delete empty per-destination logfiles that were not  updated  in
53              <b>$<a href="postconf.5.html#fast_flush_purge_time">fast_flush_purge_time</a></b> days.
54
55              This request completes in the background.
56
57       <b>purge</b>  Do a <b>refresh</b> for all per-destination logfiles.
58
59<b>SECURITY</b>
60       The  <a href="flush.8.html"><b>flush</b>(8)</a> server is not security-sensitive. It does not talk to the
61       network, and it does not talk to local users.  The  fast  flush  server
62       can run chrooted at fixed low privilege.
63
64<b>DIAGNOSTICS</b>
65       Problems and transactions are logged to <b>syslogd</b>(8) or <a href="postlogd.8.html"><b>postlogd</b>(8)</a>.
66
67<b>BUGS</b>
68       Fast flush logfiles are truncated only after a "send" request, not when
69       mail is actually delivered, and therefore can  accumulate  outdated  or
70       redundant data. In order to maintain sanity, "refresh" must be executed
71       periodically. This can be automated with a suitable wakeup  timer  set-
72       ting in the <a href="master.5.html"><b>master.cf</b></a> configuration file.
73
74       Upon  receipt of a request to deliver mail for an eligible destination,
75       the <a href="flush.8.html"><b>flush</b>(8)</a> server requests delivery of all messages that  are  listed
76       in  that  destination's  logfile, regardless of the recipients of those
77       messages. This is not an issue for mail that is sent to a <b><a href="postconf.5.html#relay_domains">relay_domains</a></b>
78       destination  because  such  mail  typically  only has recipients in one
79       domain.
80
81<b>CONFIGURATION PARAMETERS</b>
82       Changes to <a href="postconf.5.html"><b>main.cf</b></a> are picked up automatically  as  <a href="flush.8.html"><b>flush</b>(8)</a>  processes
83       run for only a limited amount of time. Use the command "<b>postfix reload</b>"
84       to speed up a change.
85
86       The text below provides only a parameter summary. See  <a href="postconf.5.html"><b>postconf</b>(5)</a>  for
87       more details including examples.
88
89       <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
90              The  default  location of the Postfix <a href="postconf.5.html">main.cf</a> and <a href="master.5.html">master.cf</a> con-
91              figuration files.
92
93       <b><a href="postconf.5.html#daemon_timeout">daemon_timeout</a> (18000s)</b>
94              How much time a Postfix daemon process  may  take  to  handle  a
95              request before it is terminated by a built-in watchdog timer.
96
97       <b><a href="postconf.5.html#fast_flush_domains">fast_flush_domains</a> ($<a href="postconf.5.html#relay_domains">relay_domains</a>)</b>
98              Optional list of destinations that are eligible for per-destina-
99              tion logfiles with mail that is queued to those destinations.
100
101       <b><a href="postconf.5.html#fast_flush_refresh_time">fast_flush_refresh_time</a> (12h)</b>
102              The time after which  a  non-empty  but  unread  per-destination
103              "fast flush" logfile needs to be refreshed.
104
105       <b><a href="postconf.5.html#fast_flush_purge_time">fast_flush_purge_time</a> (7d)</b>
106              The  time after which an empty per-destination "fast flush" log-
107              file is deleted.
108
109       <b><a href="postconf.5.html#ipc_timeout">ipc_timeout</a> (3600s)</b>
110              The time limit for sending  or  receiving  information  over  an
111              internal communication channel.
112
113       <b><a href="postconf.5.html#max_idle">max_idle</a> (100s)</b>
114              The  maximum  amount of time that an idle Postfix daemon process
115              waits for an incoming connection before terminating voluntarily.
116
117       <b><a href="postconf.5.html#max_use">max_use</a> (100)</b>
118              The maximal number of incoming connections that a Postfix daemon
119              process will service before terminating voluntarily.
120
121       <b><a href="postconf.5.html#parent_domain_matches_subdomains">parent_domain_matches_subdomains</a> (see 'postconf -d' output)</b>
122              A list of Postfix features where the pattern "example.com"  also
123              matches  subdomains  of  example.com,  instead  of  requiring an
124              explicit ".example.com" pattern.
125
126       <b><a href="postconf.5.html#process_id">process_id</a> (read-only)</b>
127              The process ID of a Postfix command or daemon process.
128
129       <b><a href="postconf.5.html#process_name">process_name</a> (read-only)</b>
130              The process name of a Postfix command or daemon process.
131
132       <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
133              The location of the Postfix top-level queue directory.
134
135       <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
136              The syslog facility of Postfix logging.
137
138       <b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b>
139              A prefix that  is  prepended  to  the  process  name  in  syslog
140              records, so that, for example, "smtpd" becomes "prefix/smtpd".
141
142       Available in Postfix 3.3 and later:
143
144       <b><a href="postconf.5.html#service_name">service_name</a> (read-only)</b>
145              The <a href="master.5.html">master.cf</a> service name of a Postfix daemon process.
146
147<b>FILES</b>
148       /var/spool/postfix/flush, "fast flush" logfiles.
149
150<b>SEE ALSO</b>
151       <a href="smtpd.8.html">smtpd(8)</a>, SMTP server
152       <a href="qmgr.8.html">qmgr(8)</a>, queue manager
153       <a href="postconf.5.html">postconf(5)</a>, configuration parameters
154       <a href="master.5.html">master(5)</a>, generic daemon options
155       <a href="master.8.html">master(8)</a>, process manager
156       <a href="postlogd.8.html">postlogd(8)</a>, Postfix logging
157       syslogd(8), system logging
158
159<b>README FILES</b>
160       <a href="ETRN_README.html">ETRN_README</a>, Postfix ETRN howto
161
162<b>LICENSE</b>
163       The Secure Mailer license must be distributed with this software.
164
165<b>HISTORY</b>
166       This service was introduced with Postfix version 1.0.
167
168<b>AUTHOR(S)</b>
169       Wietse Venema
170       IBM T.J. Watson Research
171       P.O. Box 704
172       Yorktown Heights, NY 10598, USA
173
174       Wietse Venema
175       Google, Inc.
176       111 8th Avenue
177       New York, NY 10011, USA
178
179                                                                      FLUSH(8)
180</pre> </body> </html>
181