external/ibm-public/postfix/dist/man/man1/postqueue.1

   1 .\"     $NetBSD$
   2 .\"
   3 .TH POSTQUEUE 1
   4 .ad
   5 .fi
   6 .SH NAME
   7 postqueue
   8 \-
   9 Postfix queue control
  10 .SH "SYNOPSIS"
  11 .na
  12 .nf
  13 \fBpostqueue\fR [\fB-v\fR] [\fB-c \fIconfig_dir\fR] \fB-f\fR
  14 .br
  15 \fBpostqueue\fR [\fB-v\fR] [\fB-c \fIconfig_dir\fR] \fB-i \fIqueue_id\fR
  16 .br
  17 \fBpostqueue\fR [\fB-v\fR] [\fB-c \fIconfig_dir\fR] \fB-p\fR
  18 .br
  19 \fBpostqueue\fR [\fB-v\fR] [\fB-c \fIconfig_dir\fR] \fB-s \fIsite\fR
  20 .SH DESCRIPTION
  21 .ad
  22 .fi
  23 The \fBpostqueue\fR(1) command implements the Postfix user interface
  24 for queue management. It implements operations that are
  25 traditionally available via the \fBsendmail\fR(1) command.
  26 See the \fBpostsuper\fR(1) command for queue operations
  27 that require super-user privileges such as deleting a message
  28 from the queue or changing the status of a message.
  29
  30 The following options are recognized:
  31 .IP "\fB-c \fIconfig_dir\fR"
  32 The \fBmain.cf\fR configuration file is in the named directory
  33 instead of the default configuration directory. See also the
  34 MAIL_CONFIG environment setting below.
  35 .IP \fB-f\fR
  36 Flush the queue: attempt to deliver all queued mail.
  37
  38 This option implements the traditional "\fBsendmail -q\fR" command,
  39 by contacting the Postfix \fBqmgr\fR(8) daemon.
  40
  41 Warning: flushing undeliverable mail frequently will result in
  42 poor delivery performance of all other mail.
  43 .IP "\fB-i \fIqueue_id\fR"
  44 Schedule immediate delivery of deferred mail with the
  45 specified queue ID.
  46
  47 This option implements the traditional \fBsendmail -qI\fR
  48 command, by contacting the \fBflush\fR(8) server.
  49
  50 This feature is available with Postfix version 2.4 and later.
  51 .IP \fB-p\fR
  52 Produce a traditional sendmail-style queue listing.
  53 This option implements the traditional \fBmailq\fR command,
  54 by contacting the Postfix \fBshowq\fR(8) daemon.
  55
  56 Each queue entry shows the queue file ID, message
  57 size, arrival time, sender, and the recipients that still need to
  58 be delivered.  If mail could not be delivered upon the last attempt,
  59 the reason for failure is shown. This mode of operation is implemented
  60 by executing the \fBpostqueue\fR(1) command. The queue ID string
  61 is followed by an optional status character:
  62 .RS
  63 .IP \fB*\fR
  64 The message is in the \fBactive\fR queue, i.e. the message is
  65 selected for delivery.
  66 .IP \fB!\fR
  67 The message is in the \fBhold\fR queue, i.e. no further delivery
  68 attempt will be made until the mail is taken off hold.
  69 .RE
  70 .IP "\fB-s \fIsite\fR"
  71 Schedule immediate delivery of all mail that is queued for the named
  72 \fIsite\fR. A numerical site must be specified as a valid RFC 2821
  73 address literal enclosed in [], just like in email addresses.
  74 The site must be eligible for the "fast flush" service.
  75 See \fBflush\fR(8) for more information about the "fast flush"
  76 service.
  77
  78 This option implements the traditional "\fBsendmail -qR\fIsite\fR"
  79 command, by contacting the Postfix \fBflush\fR(8) daemon.
  80 .IP \fB-v\fR
  81 Enable verbose logging for debugging purposes. Multiple \fB-v\fR
  82 options make the software increasingly verbose. As of Postfix 2.3,
  83 this option is available for the super-user only.
  84 .SH "SECURITY"
  85 .na
  86 .nf
  87 .ad
  88 .fi
  89 This program is designed to run with set-group ID privileges, so
  90 that it can connect to Postfix daemon processes.
  91 .SH DIAGNOSTICS
  92 .ad
  93 .fi
  94 Problems are logged to \fBsyslogd\fR(8) and to the standard error
  95 stream.
  96 .SH "ENVIRONMENT"
  97 .na
  98 .nf
  99 .ad
 100 .fi
 101 .IP MAIL_CONFIG
 102 Directory with the \fBmain.cf\fR file. In order to avoid exploitation
 103 of set-group ID privileges, a non-standard directory is allowed only
 104 if:
 105 .RS
 106 .IP \(bu
 107 The name is listed in the standard \fBmain.cf\fR file with the
 108 \fBalternate_config_directories\fR configuration parameter.
 109 .IP \(bu
 110 The command is invoked by the super-user.
 111 .RE
 112 .SH "CONFIGURATION PARAMETERS"
 113 .na
 114 .nf
 115 .ad
 116 .fi
 117 The following \fBmain.cf\fR parameters are especially relevant to
 118 this program.
 119 The text below provides only a parameter summary. See
 120 \fBpostconf\fR(5) for more details including examples.
 121 .IP "\fBalternate_config_directories (empty)\fR"
 122 A list of non-default Postfix configuration directories that may
 123 be specified with "-c config_directory" on the command line, or
 124 via the MAIL_CONFIG environment parameter.
 125 .IP "\fBconfig_directory (see 'postconf -d' output)\fR"
 126 The default location of the Postfix main.cf and master.cf
 127 configuration files.
 128 .IP "\fBcommand_directory (see 'postconf -d' output)\fR"
 129 The location of all postfix administrative commands.
 130 .IP "\fBfast_flush_domains ($relay_domains)\fR"
 131 Optional list of destinations that are eligible for per-destination
 132 logfiles with mail that is queued to those destinations.
 133 .IP "\fBimport_environment (see 'postconf -d' output)\fR"
 134 The list of environment parameters that a Postfix process will
 135 import from a non-Postfix parent process.
 136 .IP "\fBqueue_directory (see 'postconf -d' output)\fR"
 137 The location of the Postfix top-level queue directory.
 138 .IP "\fBsyslog_facility (mail)\fR"
 139 The syslog facility of Postfix logging.
 140 .IP "\fBsyslog_name (see 'postconf -d' output)\fR"
 141 The mail system name that is prepended to the process name in syslog
 142 records, so that "smtpd" becomes, for example, "postfix/smtpd".
 143 .IP "\fBtrigger_timeout (10s)\fR"
 144 The time limit for sending a trigger to a Postfix daemon (for
 145 example, the \fBpickup\fR(8) or \fBqmgr\fR(8) daemon).
 146 .PP
 147 Available in Postfix version 2.2 and later:
 148 .IP "\fBauthorized_flush_users (static:anyone)\fR"
 149 List of users who are authorized to flush the queue.
 150 .IP "\fBauthorized_mailq_users (static:anyone)\fR"
 151 List of users who are authorized to view the queue.
 152 .SH "FILES"
 153 .na
 154 .nf
 155 /var/spool/postfix, mail queue
 156 .SH "SEE ALSO"
 157 .na
 158 .nf
 159 qmgr(8), queue manager
 160 showq(8), list mail queue
 161 flush(8), fast flush service
 162 sendmail(1), Sendmail-compatible user interface
 163 postsuper(1), privileged queue operations
 164 .SH "README FILES"
 165 .na
 166 .nf
 167 .ad
 168 .fi
 169 Use "\fBpostconf readme_directory\fR" or
 170 "\fBpostconf html_directory\fR" to locate this information.
 171 .na
 172 .nf
 173 ETRN_README, Postfix ETRN howto
 174 .SH "LICENSE"
 175 .na
 176 .nf
 177 .ad
 178 .fi
 179 The Secure Mailer license must be distributed with this software.
 180 .SH "HISTORY"
 181 .na
 182 .nf
 183 .ad
 184 .fi
 185 The postqueue command was introduced with Postfix version 1.1.
 186 .SH "AUTHOR(S)"
 187 .na
 188 .nf
 189 Wietse Venema
 190 IBM T.J. Watson Research
 191 P.O. Box 704
 192 Yorktown Heights, NY 10598, USA