postfix-master/postqueue.1.html

   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>
   7 POSTQUEUE(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. The queue ID string is followed
  64               by an optional status character:
  65
  66               <b>*</b>      The message is in the <b>active</b> queue, i.e. the
  67                      message is selected for delivery.
  68
  69               <b>!</b>      The  message  is  in the <b>hold</b> queue, i.e. no
  70                      further delivery attempt will be made  until
  71                      the mail is taken off hold.
  72
  73        <b>-s</b> <i>site</i>
  74               Schedule  immediate  delivery  of  all mail that is
  75               queued for the named <i>site</i>. A numerical site must be
  76               specified  as  a  valid  <a href="http://tools.ietf.org/html/rfc2821">RFC  2821</a>  address literal
  77               enclosed in [], just like in email addresses.   The
  78               site must be eligible for the "fast flush" service.
  79               See <a href="flush.8.html"><b>flush</b>(8)</a> for more information about  the  "fast
  80               flush" service.
  81
  82               This  option  implements  the traditional "<b>sendmail</b>
  83               <b>-qR</b><i>site</i>"  command,  by   contacting   the   Postfix
  84               <a href="flush.8.html"><b>flush</b>(8)</a> daemon.
  85
  86        <b>-v</b>     Enable verbose logging for debugging purposes. Mul-
  87               tiple <b>-v</b> options  make  the  software  increasingly
  88               verbose.  As  of Postfix 2.3, this option is avail-
  89               able for the super-user only.
  90
  91 <b>SECURITY</b>
  92        This program is designed to run with set-group  ID  privi-
  93        leges, so that it can connect to Postfix daemon processes.
  94
  95 <b>DIAGNOSTICS</b>
  96        Problems are logged to  <b>syslogd</b>(8)  and  to  the  standard
  97        error stream.
  98
  99 <b>ENVIRONMENT</b>
 100        MAIL_CONFIG
 101               Directory  with the <a href="postconf.5.html"><b>main.cf</b></a> file. In order to avoid
 102               exploitation of set-group  ID  privileges,  a  non-
 103               standard directory is allowed only if:
 104
 105               <b>o</b>      The  name  is listed in the standard <a href="postconf.5.html"><b>main.cf</b></a>
 106                      file with  the  <b><a href="postconf.5.html#alternate_config_directories">alternate_config_directories</a></b>
 107                      configuration parameter.
 108
 109               <b>o</b>      The command is invoked by the super-user.
 110
 111 <b>CONFIGURATION PARAMETERS</b>
 112        The  following  <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant
 113        to this program.  The text below provides only a parameter
 114        summary.  See <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including exam-
 115        ples.
 116
 117        <b><a href="postconf.5.html#alternate_config_directories">alternate_config_directories</a> (empty)</b>
 118               A list of non-default Postfix configuration  direc-
 119               tories that may be specified with "-c <a href="postconf.5.html#config_directory">config_direc</a>-
 120               <a href="postconf.5.html#config_directory">tory</a>" on the command line, or via  the  MAIL_CONFIG
 121               environment parameter.
 122
 123        <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
 124               The  default  location  of  the Postfix <a href="postconf.5.html">main.cf</a> and
 125               <a href="master.5.html">master.cf</a> configuration files.
 126
 127        <b><a href="postconf.5.html#command_directory">command_directory</a> (see 'postconf -d' output)</b>
 128               The location of  all  postfix  administrative  com-
 129               mands.
 130
 131        <b><a href="postconf.5.html#fast_flush_domains">fast_flush_domains</a> ($<a href="postconf.5.html#relay_domains">relay_domains</a>)</b>
 132               Optional list of destinations that are eligible for
 133               per-destination logfiles with mail that  is  queued
 134               to those destinations.
 135
 136        <b><a href="postconf.5.html#import_environment">import_environment</a> (see 'postconf -d' output)</b>
 137               The  list  of environment parameters that a Postfix
 138               process  will  import  from  a  non-Postfix  parent
 139               process.
 140
 141        <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
 142               The  location of the Postfix top-level queue direc-
 143               tory.
 144
 145        <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
 146               The syslog facility of Postfix logging.
 147
 148        <b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b>
 149               The mail system  name  that  is  prepended  to  the
 150               process  name  in  syslog  records, so that "smtpd"
 151               becomes, for example, "postfix/smtpd".
 152
 153        <b><a href="postconf.5.html#trigger_timeout">trigger_timeout</a> (10s)</b>
 154               The time limit for sending a trigger to  a  Postfix
 155               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-
 156               mon).
 157
 158        Available in Postfix version 2.2 and later:
 159
 160        <b><a href="postconf.5.html#authorized_flush_users">authorized_flush_users</a> (static:anyone)</b>
 161               List of users  who  are  authorized  to  flush  the
 162               queue.
 163
 164        <b><a href="postconf.5.html#authorized_mailq_users">authorized_mailq_users</a> (static:anyone)</b>
 165               List of users who are authorized to view the queue.
 166
 167 <b>FILES</b>
 168        /var/spool/postfix, mail queue
 169
 170 <b>SEE ALSO</b>
 171        <a href="qmgr.8.html">qmgr(8)</a>, queue manager
 172        <a href="showq.8.html">showq(8)</a>, list mail queue
 173        <a href="flush.8.html">flush(8)</a>, fast flush service
 174        <a href="sendmail.1.html">sendmail(1)</a>, Sendmail-compatible user interface
 175        <a href="postsuper.1.html">postsuper(1)</a>, privileged queue operations
 176
 177 <b>README FILES</b>
 178        <a href="ETRN_README.html">ETRN_README</a>, Postfix ETRN howto
 179
 180 <b>LICENSE</b>
 181        The  Secure  Mailer  license must be distributed with this
 182        software.
 183
 184 <b>HISTORY</b>
 185        The postqueue command was introduced with Postfix  version
 186        1.1.
 187
 188 <b>AUTHOR(S)</b>
 189        Wietse Venema
 190        IBM T.J. Watson Research
 191        P.O. Box 704
 192        Yorktown Heights, NY 10598, USA
 193
 194                                                                   POSTQUEUE(1)
 195 </pre> </body> </html>