diff options
Diffstat (limited to 'html/postqueue.1.html')
| -rw-r--r-- | html/postqueue.1.html | 258 |
1 files changed, 258 insertions, 0 deletions
diff --git a/html/postqueue.1.html b/html/postqueue.1.html new file mode 100644 index 0000000..123e276 --- /dev/null +++ b/html/postqueue.1.html @@ -0,0 +1,258 @@ +<!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=utf-8"> +<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>#</b> The message is forced to expire. See the <a href="postsuper.1.html"><b>postsuper</b>(1)</a> + options <b>-e</b> or <b>-f</b>. + + This feature is available in Postfix 3.5 and later. + + <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="https://tools.ietf.org/html/rfc5321">RFC</a> + <a href="https://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>forced_expire</b> + The message is forced to expire (<b>true</b> or <b>false</b>). See the <a href="postsuper.1.html"><b>post-</b></a> + <a href="postsuper.1.html"><b>super</b>(1)</a> options <b>-e</b> or <b>-f</b>. + + This feature is available in Postfix 3.5 and later. + + <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="https://tools.ietf.org/html/rfc7159">RFC 7159</a> (JSON notation) + +<b>DIAGNOSTICS</b> + Problems are logged to <b>syslogd</b>(8) or <a href="postlogd.8.html"><b>postlogd</b>(8)</a>, 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 (in + the case of <a href="sendmail.1.html"><b>sendmail</b>(1)</a>, with the "-C" option), 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 variables that a privileged Postfix + process will import from a non-Postfix parent process, or + name=value environment overrides. + + <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> + A prefix that is prepended to the process name in syslog + records, so that, for example, "smtpd" becomes "prefix/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 + <a href="postlogd.8.html">postlogd(8)</a>, Postfix logging + syslogd(8), system logging + +<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> |