183 lines
5.9 KiB
Groff
183 lines
5.9 KiB
Groff
.TH FLUSH 8
|
|
.ad
|
|
.fi
|
|
.SH NAME
|
|
flush
|
|
\-
|
|
Postfix fast flush server
|
|
.SH "SYNOPSIS"
|
|
.na
|
|
.nf
|
|
\fBflush\fR [generic Postfix daemon options]
|
|
.SH DESCRIPTION
|
|
.ad
|
|
.fi
|
|
The \fBflush\fR(8) server maintains a record of deferred
|
|
mail by destination.
|
|
This information is used to improve the performance of the SMTP
|
|
\fBETRN\fR request, and of its command\-line equivalent,
|
|
"\fBsendmail \-qR\fR" or "\fBpostqueue \-f\fR".
|
|
This program expects to be run from the \fBmaster\fR(8) process
|
|
manager.
|
|
|
|
The record is implemented as a per\-destination logfile with
|
|
as contents the queue IDs of deferred mail. A logfile is
|
|
append\-only, and is truncated when delivery is requested
|
|
for the corresponding destination. A destination is the
|
|
part on the right\-hand side of the right\-most \fB@\fR in
|
|
an email address.
|
|
|
|
Per\-destination logfiles of deferred mail are maintained only for
|
|
eligible destinations. The list of eligible destinations is
|
|
specified with the \fBfast_flush_domains\fR configuration parameter,
|
|
which defaults to \fB$relay_domains\fR.
|
|
|
|
This server implements the following requests:
|
|
.IP "\fBadd\fI sitename queueid\fR"
|
|
Inform the \fBflush\fR(8) server that the message with the specified
|
|
queue ID is queued for the specified destination.
|
|
.IP "\fBsend_site\fI sitename\fR"
|
|
Request delivery of mail that is queued for the specified
|
|
destination.
|
|
.IP "\fBsend_file\fI queueid\fR"
|
|
Request delivery of the specified deferred message.
|
|
.IP \fBrefresh\fR
|
|
Refresh non\-empty per\-destination logfiles that were not read in
|
|
\fB$fast_flush_refresh_time\fR hours, by simulating
|
|
send requests (see above) for the corresponding destinations.
|
|
.sp
|
|
Delete empty per\-destination logfiles that were not updated in
|
|
\fB$fast_flush_purge_time\fR days.
|
|
.sp
|
|
This request completes in the background.
|
|
.IP \fBpurge\fR
|
|
Do a \fBrefresh\fR for all per\-destination logfiles.
|
|
.SH "SECURITY"
|
|
.na
|
|
.nf
|
|
.ad
|
|
.fi
|
|
The \fBflush\fR(8) server is not security\-sensitive. It does not
|
|
talk to the network, and it does not talk to local users.
|
|
The fast flush server can run chrooted at fixed low privilege.
|
|
.SH DIAGNOSTICS
|
|
.ad
|
|
.fi
|
|
Problems and transactions are logged to \fBsyslogd\fR(8)
|
|
or \fBpostlogd\fR(8).
|
|
.SH BUGS
|
|
.ad
|
|
.fi
|
|
Fast flush logfiles are truncated only after a "send"
|
|
request, not when mail is actually delivered, and therefore can
|
|
accumulate outdated or redundant data. In order to maintain sanity,
|
|
"refresh" must be executed periodically. This can
|
|
be automated with a suitable wakeup timer setting in the
|
|
\fBmaster.cf\fR configuration file.
|
|
|
|
Upon receipt of a request to deliver mail for an eligible
|
|
destination, the \fBflush\fR(8) server requests delivery of all messages
|
|
that are listed in that destination's logfile, regardless of the
|
|
recipients of those messages. This is not an issue for mail
|
|
that is sent to a \fBrelay_domains\fR destination because
|
|
such mail typically only has recipients in one domain.
|
|
.SH "CONFIGURATION PARAMETERS"
|
|
.na
|
|
.nf
|
|
.ad
|
|
.fi
|
|
Changes to \fBmain.cf\fR are picked up automatically as \fBflush\fR(8)
|
|
processes run for only a limited amount of time. Use the command
|
|
"\fBpostfix reload\fR" to speed up a change.
|
|
|
|
The text below provides only a parameter summary. See
|
|
\fBpostconf\fR(5) for more details including examples.
|
|
.IP "\fBconfig_directory (see 'postconf -d' output)\fR"
|
|
The default location of the Postfix main.cf and master.cf
|
|
configuration files.
|
|
.IP "\fBdaemon_timeout (18000s)\fR"
|
|
How much time a Postfix daemon process may take to handle a
|
|
request before it is terminated by a built\-in watchdog timer.
|
|
.IP "\fBfast_flush_domains ($relay_domains)\fR"
|
|
Optional list of destinations that are eligible for per\-destination
|
|
logfiles with mail that is queued to those destinations.
|
|
.IP "\fBfast_flush_refresh_time (12h)\fR"
|
|
The time after which a non\-empty but unread per\-destination "fast
|
|
flush" logfile needs to be refreshed.
|
|
.IP "\fBfast_flush_purge_time (7d)\fR"
|
|
The time after which an empty per\-destination "fast flush" logfile
|
|
is deleted.
|
|
.IP "\fBipc_timeout (3600s)\fR"
|
|
The time limit for sending or receiving information over an internal
|
|
communication channel.
|
|
.IP "\fBmax_idle (100s)\fR"
|
|
The maximum amount of time that an idle Postfix daemon process waits
|
|
for an incoming connection before terminating voluntarily.
|
|
.IP "\fBmax_use (100)\fR"
|
|
The maximal number of incoming connections that a Postfix daemon
|
|
process will service before terminating voluntarily.
|
|
.IP "\fBparent_domain_matches_subdomains (see 'postconf -d' output)\fR"
|
|
A list of Postfix features where the pattern "example.com" also
|
|
matches subdomains of example.com,
|
|
instead of requiring an explicit ".example.com" pattern.
|
|
.IP "\fBprocess_id (read\-only)\fR"
|
|
The process ID of a Postfix command or daemon process.
|
|
.IP "\fBprocess_name (read\-only)\fR"
|
|
The process name of a Postfix command or daemon process.
|
|
.IP "\fBqueue_directory (see 'postconf -d' output)\fR"
|
|
The location of the Postfix top\-level queue directory.
|
|
.IP "\fBsyslog_facility (mail)\fR"
|
|
The syslog facility of Postfix logging.
|
|
.IP "\fBsyslog_name (see 'postconf -d' output)\fR"
|
|
A prefix that is prepended to the process name in syslog
|
|
records, so that, for example, "smtpd" becomes "prefix/smtpd".
|
|
.PP
|
|
Available in Postfix 3.3 and later:
|
|
.IP "\fBservice_name (read\-only)\fR"
|
|
The master.cf service name of a Postfix daemon process.
|
|
.SH "FILES"
|
|
.na
|
|
.nf
|
|
/var/spool/postfix/flush, "fast flush" logfiles.
|
|
.SH "SEE ALSO"
|
|
.na
|
|
.nf
|
|
smtpd(8), SMTP server
|
|
qmgr(8), queue manager
|
|
postconf(5), configuration parameters
|
|
master(5), generic daemon options
|
|
master(8), process manager
|
|
postlogd(8), Postfix logging
|
|
syslogd(8), system logging
|
|
.SH "README FILES"
|
|
.na
|
|
.nf
|
|
.ad
|
|
.fi
|
|
Use "\fBpostconf readme_directory\fR" or
|
|
"\fBpostconf html_directory\fR" to locate this information.
|
|
.na
|
|
.nf
|
|
ETRN_README, Postfix ETRN howto
|
|
.SH "LICENSE"
|
|
.na
|
|
.nf
|
|
.ad
|
|
.fi
|
|
The Secure Mailer license must be distributed with this software.
|
|
.SH HISTORY
|
|
.ad
|
|
.fi
|
|
This service was introduced with Postfix version 1.0.
|
|
.SH "AUTHOR(S)"
|
|
.na
|
|
.nf
|
|
Wietse Venema
|
|
IBM T.J. Watson Research
|
|
P.O. Box 704
|
|
Yorktown Heights, NY 10598, USA
|
|
|
|
Wietse Venema
|
|
Google, Inc.
|
|
111 8th Avenue
|
|
New York, NY 10011, USA
|