xref: /netbsd-src/external/ibm-public/postfix/dist/html/postqueue.1.html (revision 9573673d78c64ea1eac42d7f2e9521be89932ae5)
1<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
2        "http://www.w3.org/TR/html4/loose.dtd">
3<html> <head>
4<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
5<title> Postfix manual - postqueue(1) </title>
6</head> <body> <pre>
7POSTQUEUE(1)                                                      POSTQUEUE(1)
8
9<b>NAME</b>
10       postqueue - Postfix queue control
11
12<b>SYNOPSIS</b>
13       <b>postqueue</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <b>-f</b>
14       <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>
15       <b>postqueue</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <b>-p</b>
16       <b>postqueue</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <b>-s</b> <i>site</i>
17
18<b>DESCRIPTION</b>
19       The  <a href="postqueue.1.html"><b>postqueue</b>(1)</a>  command  implements  the  Postfix user interface for
20       queue management.  It  implements  operations  that  are  traditionally
21       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
22       for queue operations that require super-user privileges such as  delet-
23       ing a message from the queue or changing the status of a message.
24
25       The following options are recognized:
26
27       <b>-c</b> <i>config</i><b>_</b><i>dir</i>
28              The <a href="postconf.5.html"><b>main.cf</b></a> configuration file is in the named directory instead
29              of the default configuration directory. See also the MAIL_CONFIG
30              environment setting below.
31
32       <b>-f</b>     Flush the queue: attempt to deliver all queued mail.
33
34              This option implements the traditional "<b>sendmail -q</b>" command, by
35              contacting the Postfix <a href="qmgr.8.html"><b>qmgr</b>(8)</a> daemon.
36
37              Warning: flushing undeliverable mail frequently will  result  in
38              poor delivery performance of all other mail.
39
40       <b>-i</b> <i>queue</i><b>_</b><i>id</i>
41              Schedule  immediate delivery of deferred mail with the specified
42              queue ID.
43
44              This option implements the traditional <b>sendmail -qI</b> command,  by
45              contacting the <a href="flush.8.html"><b>flush</b>(8)</a> server.
46
47              This feature is available with Postfix version 2.4 and later.
48
49       <b>-p</b>     Produce a traditional sendmail-style queue listing.  This option
50              implements the traditional  <b>mailq</b>  command,  by  contacting  the
51              Postfix <a href="showq.8.html"><b>showq</b>(8)</a> daemon.
52
53              Each  queue entry shows the queue file ID, message size, arrival
54              time, sender, and the recipients that still need  to  be  deliv-
55              ered.  If mail could not be delivered upon the last attempt, the
56              reason for failure is shown. The queue ID string is followed  by
57              an optional status character:
58
59              <b>*</b>      The  message  is in the <b>active</b> queue, i.e. the message is
60                     selected for delivery.
61
62              <b>!</b>      The message is in the <b>hold</b> queue, i.e. no further  deliv-
63                     ery  attempt  will  be  made  until the mail is taken off
64                     hold.
65
66       <b>-s</b> <i>site</i>
67              Schedule immediate delivery of all mail that is queued  for  the
68              named  <i>site</i>.  A  numerical site must be specified as a valid <a href="http://tools.ietf.org/html/rfc5321">RFC</a>
69              <a href="http://tools.ietf.org/html/rfc5321">5321</a>  address  literal  enclosed  in  [],  just  like  in  email
70              addresses.   The site must be eligible for the "fast flush" ser-
71              vice.  See <a href="flush.8.html"><b>flush</b>(8)</a> for more information about the "fast  flush"
72              service.
73
74              This  option  implements the traditional "<b>sendmail -qR</b><i>site</i>" com-
75              mand, by contacting the Postfix <a href="flush.8.html"><b>flush</b>(8)</a> daemon.
76
77       <b>-v</b>     Enable verbose  logging  for  debugging  purposes.  Multiple  <b>-v</b>
78              options  make  the  software increasingly verbose. As of Postfix
79              2.3, this option is available for the super-user only.
80
81<b>SECURITY</b>
82       This program is designed to run with set-group ID privileges,  so  that
83       it can connect to Postfix daemon processes.
84
85<b>DIAGNOSTICS</b>
86       Problems are logged to <b>syslogd</b>(8) and to the standard error stream.
87
88<b>ENVIRONMENT</b>
89       MAIL_CONFIG
90              Directory  with the <a href="postconf.5.html"><b>main.cf</b></a> file. In order to avoid exploitation
91              of set-group ID privileges, a non-standard directory is  allowed
92              only if:
93
94              <b>o</b>      The  name is listed in the standard <a href="postconf.5.html"><b>main.cf</b></a> file with the
95                     <b><a href="postconf.5.html#alternate_config_directories">alternate_config_directories</a></b> configuration parameter.
96
97              <b>o</b>      The command is invoked by the super-user.
98
99<b>CONFIGURATION PARAMETERS</b>
100       The following <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant to  this  pro-
101       gram.   The  text  below  provides  only a parameter summary. See <a href="postconf.5.html"><b>post-</b></a>
102       <a href="postconf.5.html"><b>conf</b>(5)</a> for more details including examples.
103
104       <b><a href="postconf.5.html#alternate_config_directories">alternate_config_directories</a> (empty)</b>
105              A list of non-default Postfix configuration directories that may
106              be  specified with "-c <a href="postconf.5.html#config_directory">config_directory</a>" on the command line, or
107              via the MAIL_CONFIG environment parameter.
108
109       <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
110              The default location of the Postfix <a href="postconf.5.html">main.cf</a> and  <a href="master.5.html">master.cf</a>  con-
111              figuration files.
112
113       <b><a href="postconf.5.html#command_directory">command_directory</a> (see 'postconf -d' output)</b>
114              The location of all postfix administrative commands.
115
116       <b><a href="postconf.5.html#fast_flush_domains">fast_flush_domains</a> ($<a href="postconf.5.html#relay_domains">relay_domains</a>)</b>
117              Optional list of destinations that are eligible for per-destina-
118              tion logfiles with mail that is queued to those destinations.
119
120       <b><a href="postconf.5.html#import_environment">import_environment</a> (see 'postconf -d' output)</b>
121              The list of environment parameters that a Postfix  process  will
122              import from a non-Postfix parent process.
123
124       <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
125              The location of the Postfix top-level queue directory.
126
127       <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
128              The syslog facility of Postfix logging.
129
130       <b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b>
131              The  mail  system  name that is prepended to the process name in
132              syslog records, so that "smtpd"  becomes,  for  example,  "post-
133              fix/smtpd".
134
135       <b><a href="postconf.5.html#trigger_timeout">trigger_timeout</a> (10s)</b>
136              The  time  limit  for sending a trigger to a Postfix daemon (for
137              example, the <a href="pickup.8.html"><b>pickup</b>(8)</a> or <a href="qmgr.8.html"><b>qmgr</b>(8)</a> daemon).
138
139       Available in Postfix version 2.2 and later:
140
141       <b><a href="postconf.5.html#authorized_flush_users">authorized_flush_users</a> (<a href="DATABASE_README.html#types">static</a>:anyone)</b>
142              List of users who are authorized to flush the queue.
143
144       <b><a href="postconf.5.html#authorized_mailq_users">authorized_mailq_users</a> (<a href="DATABASE_README.html#types">static</a>:anyone)</b>
145              List of users who are authorized to view the queue.
146
147<b>FILES</b>
148       /var/spool/postfix, mail queue
149
150<b>SEE ALSO</b>
151       <a href="qmgr.8.html">qmgr(8)</a>, queue manager
152       <a href="showq.8.html">showq(8)</a>, list mail queue
153       <a href="flush.8.html">flush(8)</a>, fast flush service
154       <a href="sendmail.1.html">sendmail(1)</a>, Sendmail-compatible user interface
155       <a href="postsuper.1.html">postsuper(1)</a>, privileged queue operations
156
157<b>README FILES</b>
158       <a href="ETRN_README.html">ETRN_README</a>, Postfix ETRN howto
159
160<b>LICENSE</b>
161       The Secure Mailer license must be distributed with this software.
162
163<b>HISTORY</b>
164       The postqueue command was introduced with Postfix version 1.1.
165
166<b>AUTHOR(S)</b>
167       Wietse Venema
168       IBM T.J. Watson Research
169       P.O. Box 704
170       Yorktown Heights, NY 10598, USA
171
172                                                                  POSTQUEUE(1)
173</pre> </body> </html>
174