external/ibm-public/postfix/dist/man/man8/flush.8

   1 .\"     $NetBSD$
   2 .\"
   3 .TH FLUSH 8
   4 .ad
   5 .fi
   6 .SH NAME
   7 flush
   8 \-
   9 Postfix fast flush server
  10 .SH "SYNOPSIS"
  11 .na
  12 .nf
  13 \fBflush\fR [generic Postfix daemon options]
  14 .SH DESCRIPTION
  15 .ad
  16 .fi
  17 The \fBflush\fR(8) server maintains a record of deferred
  18 mail by destination.
  19 This information is used to improve the performance of the SMTP
  20 \fBETRN\fR request, and of its command-line equivalent,
  21 "\fBsendmail -qR\fR" or "\fBpostqueue -f\fR".
  22 This program expects to be run from the \fBmaster\fR(8) process
  23 manager.
  24
  25 The record is implemented as a per-destination logfile with
  26 as contents the queue IDs of deferred mail. A logfile is
  27 append-only, and is truncated when delivery is requested
  28 for the corresponding destination. A destination is the
  29 part on the right-hand side of the right-most \fB@\fR in
  30 an email address.
  31
  32 Per-destination logfiles of deferred mail are maintained only for
  33 eligible destinations. The list of eligible destinations is
  34 specified with the \fBfast_flush_domains\fR configuration parameter,
  35 which defaults to \fB$relay_domains\fR.
  36
  37 This server implements the following requests:
  38 .IP "\fBadd\fI sitename queueid\fR"
  39 Inform the \fBflush\fR(8) server that the message with the specified
  40 queue ID is queued for the specified destination.
  41 .IP "\fBsend_site\fI sitename\fR"
  42 Request delivery of mail that is queued for the specified
  43 destination.
  44 .IP "\fBsend_file\fI queueid\fR"
  45 Request delivery of the specified deferred message.
  46 .IP \fBrefresh\fR
  47 Refresh non-empty per-destination logfiles that were not read in
  48 \fB$fast_flush_refresh_time\fR hours, by simulating
  49 send requests (see above) for the corresponding destinations.
  50 .sp
  51 Delete empty per-destination logfiles that were not updated in
  52 \fB$fast_flush_purge_time\fR days.
  53 .sp
  54 This request completes in the background.
  55 .IP \fBpurge\fR
  56 Do a \fBrefresh\fR for all per-destination logfiles.
  57 .SH "SECURITY"
  58 .na
  59 .nf
  60 .ad
  61 .fi
  62 The \fBflush\fR(8) 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 privilege.
  65 .SH DIAGNOSTICS
  66 .ad
  67 .fi
  68 Problems and transactions are logged to \fBsyslogd\fR(8).
  69 .SH BUGS
  70 .ad
  71 .fi
  72 Fast flush logfiles are truncated only after a "send"
  73 request, not when mail is actually delivered, and therefore can
  74 accumulate outdated or redundant data. In order to maintain sanity,
  75 "refresh" must be executed periodically. This can
  76 be automated with a suitable wakeup timer setting in the
  77 \fBmaster.cf\fR configuration file.
  78
  79 Upon receipt of a request to deliver mail for an eligible
  80 destination, the \fBflush\fR(8) server requests delivery of all messages
  81 that are listed in that destination's logfile, regardless of the
  82 recipients of those messages. This is not an issue for mail
  83 that is sent to a \fBrelay_domains\fR destination because
  84 such mail typically only has recipients in one domain.
  85 .SH "CONFIGURATION PARAMETERS"
  86 .na
  87 .nf
  88 .ad
  89 .fi
  90 Changes to \fBmain.cf\fR are picked up automatically as \fBflush\fR(8)
  91 processes run for only a limited amount of time. Use the command
  92 "\fBpostfix reload\fR" to speed up a change.
  93
  94 The text below provides only a parameter summary. See
  95 \fBpostconf\fR(5) for more details including examples.
  96 .IP "\fBconfig_directory (see 'postconf -d' output)\fR"
  97 The default location of the Postfix main.cf and master.cf
  98 configuration files.
  99 .IP "\fBdaemon_timeout (18000s)\fR"
 100 How much time a Postfix daemon process may take to handle a
 101 request before it is terminated by a built-in watchdog timer.
 102 .IP "\fBfast_flush_domains ($relay_domains)\fR"
 103 Optional list of destinations that are eligible for per-destination
 104 logfiles with mail that is queued to those destinations.
 105 .IP "\fBfast_flush_refresh_time (12h)\fR"
 106 The time after which a non-empty but unread per-destination "fast
 107 flush" logfile needs to be refreshed.
 108 .IP "\fBfast_flush_purge_time (7d)\fR"
 109 The time after which an empty per-destination "fast flush" logfile
 110 is deleted.
 111 .IP "\fBipc_timeout (3600s)\fR"
 112 The time limit for sending or receiving information over an internal
 113 communication channel.
 114 .IP "\fBmax_idle (100s)\fR"
 115 The maximum amount of time that an idle Postfix daemon process waits
 116 for an incoming connection before terminating voluntarily.
 117 .IP "\fBmax_use (100)\fR"
 118 The maximal number of incoming connections that a Postfix daemon
 119 process will service before terminating voluntarily.
 120 .IP "\fBparent_domain_matches_subdomains (see 'postconf -d' output)\fR"
 121 What Postfix features match subdomains of "domain.tld" automatically,
 122 instead of requiring an explicit ".domain.tld" pattern.
 123 .IP "\fBprocess_id (read-only)\fR"
 124 The process ID of a Postfix command or daemon process.
 125 .IP "\fBprocess_name (read-only)\fR"
 126 The process name of a Postfix command or daemon process.
 127 .IP "\fBqueue_directory (see 'postconf -d' output)\fR"
 128 The location of the Postfix top-level queue directory.
 129 .IP "\fBsyslog_facility (mail)\fR"
 130 The syslog facility of Postfix logging.
 131 .IP "\fBsyslog_name (see 'postconf -d' output)\fR"
 132 The mail system name that is prepended to the process name in syslog
 133 records, so that "smtpd" becomes, for example, "postfix/smtpd".
 134 .SH "FILES"
 135 .na
 136 .nf
 137 /var/spool/postfix/flush, "fast flush" logfiles.
 138 .SH "SEE ALSO"
 139 .na
 140 .nf
 141 smtpd(8), SMTP server
 142 qmgr(8), queue manager
 143 postconf(5), configuration parameters
 144 master(5), generic daemon options
 145 master(8), process manager
 146 syslogd(8), system logging
 147 .SH "README FILES"
 148 .na
 149 .nf
 150 .ad
 151 .fi
 152 Use "\fBpostconf readme_directory\fR" or
 153 "\fBpostconf html_directory\fR" to locate this information.
 154 .na
 155 .nf
 156 ETRN_README, Postfix ETRN howto
 157 .SH "LICENSE"
 158 .na
 159 .nf
 160 .ad
 161 .fi
 162 The Secure Mailer license must be distributed with this software.
 163 .SH "HISTORY"
 164 .na
 165 .nf
 166 This service was introduced with Postfix version 1.0.
 167 .SH "AUTHOR(S)"
 168 .na
 169 .nf
 170 Wietse Venema
 171 IBM T.J. Watson Research
 172 P.O. Box 704
 173 Yorktown Heights, NY 10598, USA