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