/usr/share/doc/postfix/html/postqueue.1.html is in postfix-doc 3.1.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | <!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html> <head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title> Postfix manual - postqueue(1) </title>
</head> <body> <pre>
POSTQUEUE(1) POSTQUEUE(1)
<b>NAME</b>
postqueue - Postfix queue control
<b>SYNOPSIS</b>
<b>To flush the mail queue</b>:
<b>postqueue</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <b>-f</b>
<b>postqueue</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <b>-i</b> <i>queue</i><b>_</b><i>id</i>
<b>postqueue</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <b>-s</b> <i>site</i>
<b>To list the mail queue</b>:
<b>postqueue</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <b>-j</b>
<b>postqueue</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <b>-p</b>
<b>DESCRIPTION</b>
The <a href="postqueue.1.html"><b>postqueue</b>(1)</a> command implements the Postfix user interface for
queue management. It implements operations that are traditionally
available via the <a href="sendmail.1.html"><b>sendmail</b>(1)</a> command. See the <a href="postsuper.1.html"><b>postsuper</b>(1)</a> command
for queue operations that require super-user privileges such as delet-
ing a message from the queue or changing the status of a message.
The following options are recognized:
<b>-c</b> <i>config</i><b>_</b><i>dir</i>
The <a href="postconf.5.html"><b>main.cf</b></a> configuration file is in the named directory instead
of the default configuration directory. See also the MAIL_CONFIG
environment setting below.
<b>-f</b> Flush the queue: attempt to deliver all queued mail.
This option implements the traditional "<b>sendmail -q</b>" command, by
contacting the Postfix <a href="qmgr.8.html"><b>qmgr</b>(8)</a> daemon.
Warning: flushing undeliverable mail frequently will result in
poor delivery performance of all other mail.
<b>-i</b> <i>queue</i><b>_</b><i>id</i>
Schedule immediate delivery of deferred mail with the specified
queue ID.
This option implements the traditional <b>sendmail -qI</b> command, by
contacting the <a href="flush.8.html"><b>flush</b>(8)</a> server.
This feature is available with Postfix version 2.4 and later.
<b>-j</b> Produce a queue listing in JSON format, based on output from the
<a href="showq.8.html">showq(8)</a> daemon. The result is a stream of zero or more JSON
objects, one per queue file. Each object is followed by a new-
line character to support simple streaming parsers. See "<b>JSON</b>
<b>OBJECT FORMAT</b>" below for details.
This feature is available in Postfix 3.1 and later.
<b>-p</b> Produce a traditional sendmail-style queue listing. This option
implements the traditional <b>mailq</b> command, by contacting the
Postfix <a href="showq.8.html"><b>showq</b>(8)</a> daemon.
Each queue entry shows the queue file ID, message size, arrival
time, sender, and the recipients that still need to be deliv-
ered. If mail could not be delivered upon the last attempt, the
reason for failure is shown. The queue ID string is followed by
an optional status character:
<b>*</b> The message is in the <b>active</b> queue, i.e. the message is
selected for delivery.
<b>!</b> The message is in the <b>hold</b> queue, i.e. no further deliv-
ery attempt will be made until the mail is taken off
hold.
<b>-s</b> <i>site</i>
Schedule immediate delivery of all mail that is queued for the
named <i>site</i>. A numerical site must be specified as a valid <a href="http://tools.ietf.org/html/rfc5321">RFC</a>
<a href="http://tools.ietf.org/html/rfc5321">5321</a> address literal enclosed in [], just like in email
addresses. The site must be eligible for the "fast flush" ser-
vice. See <a href="flush.8.html"><b>flush</b>(8)</a> for more information about the "fast flush"
service.
This option implements the traditional "<b>sendmail -qR</b><i>site</i>" com-
mand, by contacting the Postfix <a href="flush.8.html"><b>flush</b>(8)</a> daemon.
<b>-v</b> Enable verbose logging for debugging purposes. Multiple <b>-v</b>
options make the software increasingly verbose. As of Postfix
2.3, this option is available for the super-user only.
<b>JSON OBJECT FORMAT</b>
Each JSON object represents one queue file; it is emitted as a single
text line followed by a newline character.
Object members have string values unless indicated otherwise. Programs
should ignore object members that are not listed here; the list of mem-
bers is expected to grow over time.
<b>queue_name</b>
The name of the queue where the message was found. Note that
the contents of the mail queue may change while it is being
listed; some messages may appear more than once, and some mes-
sages may be missed.
<b>queue_id</b>
The queue file name. The queue_id may be reused within a Postfix
instance unless "<a href="postconf.5.html#enable_long_queue_ids">enable_long_queue_ids</a> = true" and time is mono-
tonic. Even then, the queue_id is not expected to be unique
between different Postfix instances. Management tools that
require a unique name should combine the queue_id with the
<a href="postconf.5.html#myhostname">myhostname</a> setting of the Postfix instance.
<b>arrival_time</b>
The number of seconds since the start of the UNIX epoch.
<b>message_size</b>
The number of bytes in the message header and body. This number
does not include message envelope information. It is approxi-
mately equal to the number of bytes that would be transmitted
via SMTP including the <CR><LF> line endings.
<b>sender</b> The envelope sender address.
<b>recipients</b>
An array containing zero or more objects with members:
<b>address</b>
One recipient address.
<b>delay_reason</b>
If present, the reason for delayed delivery. Delayed
recipients may have no delay reason, for example, while
delivery is in progress, or after the system was stopped
before it could record the reason.
<b>SECURITY</b>
This program is designed to run with set-group ID privileges, so that
it can connect to Postfix daemon processes.
<b>STANDARDS</b>
<a href="http://tools.ietf.org/html/rfc7159">RFC 7159</a> (JSON notation)
<b>DIAGNOSTICS</b>
Problems are logged to <b>syslogd</b>(8) and to the standard error stream.
<b>ENVIRONMENT</b>
MAIL_CONFIG
Directory with the <a href="postconf.5.html"><b>main.cf</b></a> file. In order to avoid exploitation
of set-group ID privileges, a non-standard directory is allowed
only if:
<b>o</b> The name is listed in the standard <a href="postconf.5.html"><b>main.cf</b></a> file with the
<b><a href="postconf.5.html#alternate_config_directories">alternate_config_directories</a></b> configuration parameter.
<b>o</b> The command is invoked by the super-user.
<b>CONFIGURATION PARAMETERS</b>
The following <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant to this pro-
gram. The text below provides only a parameter summary. See <a href="postconf.5.html"><b>post-</b></a>
<a href="postconf.5.html"><b>conf</b>(5)</a> for more details including examples.
<b><a href="postconf.5.html#alternate_config_directories">alternate_config_directories</a> (empty)</b>
A list of non-default Postfix configuration directories that may
be specified with "-c <a href="postconf.5.html#config_directory">config_directory</a>" on the command line, or
via the MAIL_CONFIG environment parameter.
<b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
The default location of the Postfix <a href="postconf.5.html">main.cf</a> and <a href="master.5.html">master.cf</a> con-
figuration files.
<b><a href="postconf.5.html#command_directory">command_directory</a> (see 'postconf -d' output)</b>
The location of all postfix administrative commands.
<b><a href="postconf.5.html#fast_flush_domains">fast_flush_domains</a> ($<a href="postconf.5.html#relay_domains">relay_domains</a>)</b>
Optional list of destinations that are eligible for per-destina-
tion logfiles with mail that is queued to those destinations.
<b><a href="postconf.5.html#import_environment">import_environment</a> (see 'postconf -d' output)</b>
The list of environment parameters that a Postfix process will
import from a non-Postfix parent process.
<b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
The location of the Postfix top-level queue directory.
<b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
The syslog facility of Postfix logging.
<b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b>
The mail system name that is prepended to the process name in
syslog records, so that "smtpd" becomes, for example, "post-
fix/smtpd".
<b><a href="postconf.5.html#trigger_timeout">trigger_timeout</a> (10s)</b>
The time limit for sending a trigger to a Postfix daemon (for
example, the <a href="pickup.8.html"><b>pickup</b>(8)</a> or <a href="qmgr.8.html"><b>qmgr</b>(8)</a> daemon).
Available in Postfix version 2.2 and later:
<b><a href="postconf.5.html#authorized_flush_users">authorized_flush_users</a> (<a href="DATABASE_README.html#types">static</a>:anyone)</b>
List of users who are authorized to flush the queue.
<b><a href="postconf.5.html#authorized_mailq_users">authorized_mailq_users</a> (<a href="DATABASE_README.html#types">static</a>:anyone)</b>
List of users who are authorized to view the queue.
<b>FILES</b>
/var/spool/postfix, mail queue
<b>SEE ALSO</b>
<a href="qmgr.8.html">qmgr(8)</a>, queue manager
<a href="showq.8.html">showq(8)</a>, list mail queue
<a href="flush.8.html">flush(8)</a>, fast flush service
<a href="sendmail.1.html">sendmail(1)</a>, Sendmail-compatible user interface
<a href="postsuper.1.html">postsuper(1)</a>, privileged queue operations
<b>README FILES</b>
<a href="ETRN_README.html">ETRN_README</a>, Postfix ETRN howto
<b>LICENSE</b>
The Secure Mailer license must be distributed with this software.
<b>HISTORY</b>
The postqueue command was introduced with Postfix version 1.1.
<b>AUTHOR(S)</b>
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
POSTQUEUE(1)
</pre> </body> </html>
|