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