diff options
Diffstat (limited to '')
| -rw-r--r-- | man/man1/postqueue.1 | 269 |
1 files changed, 269 insertions, 0 deletions
diff --git a/man/man1/postqueue.1 b/man/man1/postqueue.1 new file mode 100644 index 0000000..d042a34 --- /dev/null +++ b/man/man1/postqueue.1 @@ -0,0 +1,269 @@ +.TH POSTQUEUE 1 +.ad +.fi +.SH NAME +postqueue +\- +Postfix queue control +.SH "SYNOPSIS" +.na +.nf +.ti -4 +\fBTo flush the mail queue\fR: + +\fBpostqueue\fR [\fB\-v\fR] [\fB\-c \fIconfig_dir\fR] \fB\-f\fR + +\fBpostqueue\fR [\fB\-v\fR] [\fB\-c \fIconfig_dir\fR] \fB\-i \fIqueue_id\fR + +\fBpostqueue\fR [\fB\-v\fR] [\fB\-c \fIconfig_dir\fR] \fB\-s \fIsite\fR + +.ti -4 +\fBTo list the mail queue\fR: + +\fBpostqueue\fR [\fB\-v\fR] [\fB\-c \fIconfig_dir\fR] \fB\-j\fR + +\fBpostqueue\fR [\fB\-v\fR] [\fB\-c \fIconfig_dir\fR] \fB\-p\fR +.SH DESCRIPTION +.ad +.fi +The \fBpostqueue\fR(1) command implements the Postfix user interface +for queue management. It implements operations that are +traditionally available via the \fBsendmail\fR(1) command. +See the \fBpostsuper\fR(1) command for queue operations +that require super\-user privileges such as deleting a message +from the queue or changing the status of a message. + +The following options are recognized: +.IP "\fB\-c \fIconfig_dir\fR" +The \fBmain.cf\fR configuration file is in the named directory +instead of the default configuration directory. See also the +MAIL_CONFIG environment setting below. +.IP \fB\-f\fR +Flush the queue: attempt to deliver all queued mail. + +This option implements the traditional "\fBsendmail \-q\fR" command, +by contacting the Postfix \fBqmgr\fR(8) daemon. + +Warning: flushing undeliverable mail frequently will result in +poor delivery performance of all other mail. +.IP "\fB\-i \fIqueue_id\fR" +Schedule immediate delivery of deferred mail with the +specified queue ID. + +This option implements the traditional \fBsendmail \-qI\fR +command, by contacting the \fBflush\fR(8) server. + +This feature is available with Postfix version 2.4 and later. +.IP "\fB\-j\fR" +Produce a queue listing in JSON LINES format, based on +output from the showq(8) daemon. See "\fBJSON OBJECT +FORMAT\fR" below for details. + +This feature is available in Postfix 3.1 and later. +.IP \fB\-p\fR +Produce a traditional sendmail\-style queue listing. +This option implements the traditional \fBmailq\fR command, +by contacting the Postfix \fBshowq\fR(8) daemon. + +Each queue entry shows the queue file ID, message +size, arrival time, sender, and the recipients that still need to +be delivered. 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: +.RS +.IP \fB*\fR +The message is in the \fBactive\fR queue, i.e. the message is +selected for delivery. +.IP \fB!\fR +The message is in the \fBhold\fR queue, i.e. no further delivery +attempt will be made until the mail is taken off hold. +.IP \fB#\fR +The message is forced to expire. See the \fBpostsuper\fR(1) +options \fB\-e\fR or \fB\-f\fR. +.sp +This feature is available in Postfix 3.5 and later. +.RE +.IP "\fB\-s \fIsite\fR" +Schedule immediate delivery of all mail that is queued for the named +\fIsite\fR. A numerical site must be specified as a valid RFC 5321 +address literal enclosed in [], just like in email addresses. +The site must be eligible for the "fast flush" service. +See \fBflush\fR(8) for more information about the "fast flush" +service. + +This option implements the traditional "\fBsendmail \-qR\fIsite\fR" +command, by contacting the Postfix \fBflush\fR(8) daemon. +.IP \fB\-v\fR +Enable verbose logging for debugging purposes. Multiple \fB\-v\fR +options make the software increasingly verbose. As of Postfix 2.3, +this option is available for the super\-user only. +.SH "JSON OBJECT FORMAT" +.na +.nf +.ad +.fi +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 members is expected to grow over time. +.IP \fBqueue_name\fR +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 messages may be missed. +.IP \fBqueue_id\fR +The queue file name. The queue_id may be reused within a +Postfix instance unless "enable_long_queue_ids = true" and +time is monotonic. 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 myhostname setting of the Postfix instance. +.IP \fBarrival_time\fR +The number of seconds since the start of the UNIX epoch. +.IP \fBmessage_size\fR +The number of bytes in the message header and body. This +number does not include message envelope information. It +is approximately equal to the number of bytes that would +be transmitted via SMTP including the <CR><LF> line endings. +.IP \fBforced_expire\fR +The message is forced to expire (\fBtrue\fR or \fBfalse\fR). +See the \fBpostsuper\fR(1) options \fB\-e\fR or \fB\-f\fR. +.sp +This feature is available in Postfix 3.5 and later. +.IP \fBsender\fR +The envelope sender address. +.IP \fBrecipients\fR +An array containing zero or more objects with members: +.RS +.IP \fBaddress\fR +One recipient address. +.IP \fBdelay_reason\fR +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. +.RE +.SH "SECURITY" +.na +.nf +.ad +.fi +This program is designed to run with set\-group ID privileges, so +that it can connect to Postfix daemon processes. +.SH "STANDARDS" +.na +.nf +RFC 7159 (JSON notation) +.SH DIAGNOSTICS +.ad +.fi +Problems are logged to \fBsyslogd\fR(8) or \fBpostlogd\fR(8), +and to the standard error stream. +.SH "ENVIRONMENT" +.na +.nf +.ad +.fi +.IP MAIL_CONFIG +Directory with the \fBmain.cf\fR file. In order to avoid exploitation +of set\-group ID privileges, a non\-standard directory is allowed only +if: +.RS +.IP \(bu +The name is listed in the standard \fBmain.cf\fR file with the +\fBalternate_config_directories\fR configuration parameter. +.IP \(bu +The command is invoked by the super\-user. +.RE +.SH "CONFIGURATION PARAMETERS" +.na +.nf +.ad +.fi +The following \fBmain.cf\fR parameters are especially relevant to +this program. +The text below provides only a parameter summary. See +\fBpostconf\fR(5) for more details including examples. +.IP "\fBalternate_config_directories (empty)\fR" +A list of non\-default Postfix configuration directories that may +be specified with "\-c config_directory" on the command line (in the +case of \fBsendmail\fR(1), with the "\-C" option), or via the MAIL_CONFIG +environment parameter. +.IP "\fBconfig_directory (see 'postconf -d' output)\fR" +The default location of the Postfix main.cf and master.cf +configuration files. +.IP "\fBcommand_directory (see 'postconf -d' output)\fR" +The location of all postfix administrative commands. +.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 "\fBimport_environment (see 'postconf -d' output)\fR" +The list of environment variables that a privileged Postfix +process will import from a non\-Postfix parent process, or name=value +environment overrides. +.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". +.IP "\fBtrigger_timeout (10s)\fR" +The time limit for sending a trigger to a Postfix daemon (for +example, the \fBpickup\fR(8) or \fBqmgr\fR(8) daemon). +.PP +Available in Postfix version 2.2 and later: +.IP "\fBauthorized_flush_users (static:anyone)\fR" +List of users who are authorized to flush the queue. +.IP "\fBauthorized_mailq_users (static:anyone)\fR" +List of users who are authorized to view the queue. +.SH "FILES" +.na +.nf +/var/spool/postfix, mail queue +.SH "SEE ALSO" +.na +.nf +qmgr(8), queue manager +showq(8), list mail queue +flush(8), fast flush service +sendmail(1), Sendmail\-compatible user interface +postsuper(1), privileged queue operations +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 +.ad +.fi +The postqueue command was introduced with Postfix version 1.1. +.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 |