Home | History | Annotate | Line # | Download | only in html
postsuper.1.html revision 1.1.1.1.2.2
      1  1.1.1.1.2.2  snj <!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
      2  1.1.1.1.2.2  snj         "http://www.w3.org/TR/html4/loose.dtd">
      3  1.1.1.1.2.2  snj <html> <head>
      4  1.1.1.1.2.2  snj <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
      5  1.1.1.1.2.2  snj <title> Postfix manual - postsuper(1) </title>
      6  1.1.1.1.2.2  snj </head> <body> <pre>
      7  1.1.1.1.2.2  snj POSTSUPER(1)                                                      POSTSUPER(1)
      8  1.1.1.1.2.2  snj 
      9  1.1.1.1.2.2  snj <b>NAME</b>
     10  1.1.1.1.2.2  snj        postsuper - Postfix superintendent
     11  1.1.1.1.2.2  snj 
     12  1.1.1.1.2.2  snj <b>SYNOPSIS</b>
     13  1.1.1.1.2.2  snj        <b>postsuper</b> [<b>-psv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<b>-d</b> <i>queue</i><b>_</b><i>id</i>]
     14  1.1.1.1.2.2  snj                [<b>-h</b> <i>queue</i><b>_</b><i>id</i>] [<b>-H</b> <i>queue</i><b>_</b><i>id</i>]
     15  1.1.1.1.2.2  snj                [<b>-r</b> <i>queue</i><b>_</b><i>id</i>] [<i>directory ...</i>]
     16  1.1.1.1.2.2  snj 
     17  1.1.1.1.2.2  snj <b>DESCRIPTION</b>
     18  1.1.1.1.2.2  snj        The  <a href="postsuper.1.html"><b>postsuper</b>(1)</a>  command  does  maintenance  jobs on the
     19  1.1.1.1.2.2  snj        Postfix queue. Use of the command  is  restricted  to  the
     20  1.1.1.1.2.2  snj        superuser.   See the <a href="postqueue.1.html"><b>postqueue</b>(1)</a> command for unprivileged
     21  1.1.1.1.2.2  snj        queue operations such as  listing  or  flushing  the  mail
     22  1.1.1.1.2.2  snj        queue.
     23  1.1.1.1.2.2  snj 
     24  1.1.1.1.2.2  snj        By default, <a href="postsuper.1.html"><b>postsuper</b>(1)</a> performs the operations requested
     25  1.1.1.1.2.2  snj        with the <b>-s</b> and <b>-p</b> command-line  options  on  all  Postfix
     26  1.1.1.1.2.2  snj        queue directories - this includes the <b>incoming</b>, <b>active</b> and
     27  1.1.1.1.2.2  snj        <b>deferred</b> directories  with  mail  files  and  the  <b>bounce</b>,
     28  1.1.1.1.2.2  snj        <b>defer</b>, <b>trace</b> and <b>flush</b> directories with log files.
     29  1.1.1.1.2.2  snj 
     30  1.1.1.1.2.2  snj        Options:
     31  1.1.1.1.2.2  snj 
     32  1.1.1.1.2.2  snj        <b>-c</b> <i>config</i><b>_</b><i>dir</i>
     33  1.1.1.1.2.2  snj               The  <a href="postconf.5.html"><b>main.cf</b></a>  configuration  file  is  in the named
     34  1.1.1.1.2.2  snj               directory  instead  of  the  default  configuration
     35  1.1.1.1.2.2  snj               directory.  See  also  the  MAIL_CONFIG environment
     36  1.1.1.1.2.2  snj               setting below.
     37  1.1.1.1.2.2  snj 
     38  1.1.1.1.2.2  snj        <b>-d</b> <i>queue</i><b>_</b><i>id</i>
     39  1.1.1.1.2.2  snj               Delete one message with the named queue ID from the
     40  1.1.1.1.2.2  snj               named   mail  queue(s)  (default:  <b>hold</b>,  <b>incoming</b>,
     41  1.1.1.1.2.2  snj               <b>active</b> and <b>deferred</b>).
     42  1.1.1.1.2.2  snj 
     43  1.1.1.1.2.2  snj               If a <i>queue</i><b>_</b><i>id</i> of <b>-</b> is specified, the program  reads
     44  1.1.1.1.2.2  snj               queue  IDs  from  standard  input.  For example, to
     45  1.1.1.1.2.2  snj               delete  all  mail  with   exactly   one   recipient
     46  1.1.1.1.2.2  snj               <b>user (a] example.com</b>:
     47  1.1.1.1.2.2  snj 
     48  1.1.1.1.2.2  snj               mailq | tail +2 | grep -v '^ *(' | awk  'BEGIN { RS = "" }
     49  1.1.1.1.2.2  snj                   # $7=sender, $8=recipient1, $9=recipient2
     50  1.1.1.1.2.2  snj                   { if ($8 == "user (a] example.com" &amp;&amp; $9 == "")
     51  1.1.1.1.2.2  snj                         print $1 }
     52  1.1.1.1.2.2  snj               ' | tr -d '*!' | postsuper -d -
     53  1.1.1.1.2.2  snj 
     54  1.1.1.1.2.2  snj               Specify  "<b>-d ALL</b>" to remove all messages; for exam-
     55  1.1.1.1.2.2  snj               ple, specify "<b>-d ALL deferred</b>" to delete  all  mail
     56  1.1.1.1.2.2  snj               in  the  <b>deferred</b>  queue.  As a safety measure, the
     57  1.1.1.1.2.2  snj               word <b>ALL</b> must be specified in upper case.
     58  1.1.1.1.2.2  snj 
     59  1.1.1.1.2.2  snj               Warning: Postfix queue IDs are reused.  There is  a
     60  1.1.1.1.2.2  snj               very  small  possibility that postsuper deletes the
     61  1.1.1.1.2.2  snj               wrong message file when it is  executed  while  the
     62  1.1.1.1.2.2  snj               Postfix mail system is delivering mail.
     63  1.1.1.1.2.2  snj 
     64  1.1.1.1.2.2  snj               The scenario is as follows:
     65  1.1.1.1.2.2  snj 
     66  1.1.1.1.2.2  snj               1)     The  Postfix  queue manager deletes the mes-
     67  1.1.1.1.2.2  snj                      sage that <a href="postsuper.1.html"><b>postsuper</b>(1)</a> is asked  to  delete,
     68  1.1.1.1.2.2  snj                      because Postfix is finished with the message
     69  1.1.1.1.2.2  snj                      (it is delivered, or it is returned  to  the
     70  1.1.1.1.2.2  snj                      sender).
     71  1.1.1.1.2.2  snj 
     72  1.1.1.1.2.2  snj               2)     New  mail  arrives,  and  the new message is
     73  1.1.1.1.2.2  snj                      given the same queue ID as the message  that
     74  1.1.1.1.2.2  snj                      <a href="postsuper.1.html"><b>postsuper</b>(1)</a>  is  supposed  to  delete.  The
     75  1.1.1.1.2.2  snj                      probability for reusing a deleted  queue  ID
     76  1.1.1.1.2.2  snj                      is about 1 in 2**15 (the number of different
     77  1.1.1.1.2.2  snj                      microsecond values that the system clock can
     78  1.1.1.1.2.2  snj                      distinguish within a second).
     79  1.1.1.1.2.2  snj 
     80  1.1.1.1.2.2  snj               3)     <a href="postsuper.1.html"><b>postsuper</b>(1)</a>   deletes   the   new  message,
     81  1.1.1.1.2.2  snj                      instead of the old message  that  it  should
     82  1.1.1.1.2.2  snj                      have deleted.
     83  1.1.1.1.2.2  snj 
     84  1.1.1.1.2.2  snj        <b>-h</b> <i>queue</i><b>_</b><i>id</i>
     85  1.1.1.1.2.2  snj               Put  mail  "on  hold" so that no attempt is made to
     86  1.1.1.1.2.2  snj               deliver it.  Move one message with the named  queue
     87  1.1.1.1.2.2  snj               ID from the named mail queue(s) (default: <b>incoming</b>,
     88  1.1.1.1.2.2  snj               <b>active</b> and <b>deferred</b>) to the <b>hold</b> queue.
     89  1.1.1.1.2.2  snj 
     90  1.1.1.1.2.2  snj               If a <i>queue</i><b>_</b><i>id</i> of <b>-</b> is specified, the program  reads
     91  1.1.1.1.2.2  snj               queue IDs from standard input.
     92  1.1.1.1.2.2  snj 
     93  1.1.1.1.2.2  snj               Specify "<b>-h ALL</b>" to hold all messages; for example,
     94  1.1.1.1.2.2  snj               specify "<b>-h ALL deferred</b>" to hold all mail  in  the
     95  1.1.1.1.2.2  snj               <b>deferred</b>  queue.  As a safety measure, the word <b>ALL</b>
     96  1.1.1.1.2.2  snj               must be specified in upper case.
     97  1.1.1.1.2.2  snj 
     98  1.1.1.1.2.2  snj               Note: while mail is "on hold" it  will  not  expire
     99  1.1.1.1.2.2  snj               when  its  time  in  the  queue  exceeds  the <b><a href="postconf.5.html#maximal_queue_lifetime">maxi</a>-</b>
    100  1.1.1.1.2.2  snj               <b><a href="postconf.5.html#maximal_queue_lifetime">mal_queue_lifetime</a></b>  or  <b><a href="postconf.5.html#bounce_queue_lifetime">bounce_queue_lifetime</a></b>  set-
    101  1.1.1.1.2.2  snj               ting.  It becomes subject to expiration after it is
    102  1.1.1.1.2.2  snj               released from "hold".
    103  1.1.1.1.2.2  snj 
    104  1.1.1.1.2.2  snj               This feature is available in Postfix 2.0 and later.
    105  1.1.1.1.2.2  snj 
    106  1.1.1.1.2.2  snj        <b>-H</b> <i>queue</i><b>_</b><i>id</i>
    107  1.1.1.1.2.2  snj               Release mail that was put "on hold".  Move one mes-
    108  1.1.1.1.2.2  snj               sage with the named queue ID from  the  named  mail
    109  1.1.1.1.2.2  snj               queue(s) (default: <b>hold</b>) to the <b>deferred</b> queue.
    110  1.1.1.1.2.2  snj 
    111  1.1.1.1.2.2  snj               If  a <i>queue</i><b>_</b><i>id</i> of <b>-</b> is specified, the program reads
    112  1.1.1.1.2.2  snj               queue IDs from standard input.
    113  1.1.1.1.2.2  snj 
    114  1.1.1.1.2.2  snj               Note: specify "<b>postsuper -r</b>" to release  mail  that
    115  1.1.1.1.2.2  snj               was  kept  on  hold  for  a significant fraction of
    116  1.1.1.1.2.2  snj               <b>$<a href="postconf.5.html#maximal_queue_lifetime">maximal_queue_lifetime</a></b> or  <b>$<a href="postconf.5.html#bounce_queue_lifetime">bounce_queue_lifetime</a></b>,
    117  1.1.1.1.2.2  snj               or longer.
    118  1.1.1.1.2.2  snj 
    119  1.1.1.1.2.2  snj               Specify  "<b>-H  ALL</b>"  to release all mail that is "on
    120  1.1.1.1.2.2  snj               hold".  As a safety measure, the word <b>ALL</b>  must  be
    121  1.1.1.1.2.2  snj               specified in upper case.
    122  1.1.1.1.2.2  snj 
    123  1.1.1.1.2.2  snj               This feature is available in Postfix 2.0 and later.
    124  1.1.1.1.2.2  snj 
    125  1.1.1.1.2.2  snj        <b>-p</b>     Purge old temporary files that are left over  after
    126  1.1.1.1.2.2  snj               system or software crashes.
    127  1.1.1.1.2.2  snj 
    128  1.1.1.1.2.2  snj        <b>-r</b> <i>queue</i><b>_</b><i>id</i>
    129  1.1.1.1.2.2  snj               Requeue  the  message  with the named queue ID from
    130  1.1.1.1.2.2  snj               the named mail queue(s) (default:  <b>hold</b>,  <b>incoming</b>,
    131  1.1.1.1.2.2  snj               <b>active</b>  and  <b>deferred</b>).   To  requeue multiple mes-
    132  1.1.1.1.2.2  snj               sages, specify multiple <b>-r</b> command-line options.
    133  1.1.1.1.2.2  snj 
    134  1.1.1.1.2.2  snj               Alternatively, if a <i>queue</i><b>_</b><i>id</i> of <b>-</b> is specified, the
    135  1.1.1.1.2.2  snj               program reads queue IDs from standard input.
    136  1.1.1.1.2.2  snj 
    137  1.1.1.1.2.2  snj               Specify  "<b>-r  ALL</b>"  to  requeue  all messages. As a
    138  1.1.1.1.2.2  snj               safety measure, the word <b>ALL</b> must be  specified  in
    139  1.1.1.1.2.2  snj               upper case.
    140  1.1.1.1.2.2  snj 
    141  1.1.1.1.2.2  snj               A  requeued message is moved to the <b>maildrop</b> queue,
    142  1.1.1.1.2.2  snj               from where  it  is  copied  by  the  <a href="pickup.8.html"><b>pickup</b>(8)</a>  and
    143  1.1.1.1.2.2  snj               <a href="cleanup.8.html"><b>cleanup</b>(8)</a>  daemons  to  a  new queue file. In many
    144  1.1.1.1.2.2  snj               respects its handling differs from that  of  a  new
    145  1.1.1.1.2.2  snj               local submission.
    146  1.1.1.1.2.2  snj 
    147  1.1.1.1.2.2  snj               <b>o</b>      The   message   is   not  subjected  to  the
    148  1.1.1.1.2.2  snj                      <a href="postconf.5.html#smtpd_milters">smtpd_milters</a> or <a href="postconf.5.html#non_smtpd_milters">non_smtpd_milters</a> settings.
    149  1.1.1.1.2.2  snj                      When  mail  has  passed  through an external
    150  1.1.1.1.2.2  snj                      content filter, this would produce incorrect
    151  1.1.1.1.2.2  snj                      results with Milter applications that depend
    152  1.1.1.1.2.2  snj                      on original SMTP connection  state  informa-
    153  1.1.1.1.2.2  snj                      tion.
    154  1.1.1.1.2.2  snj 
    155  1.1.1.1.2.2  snj               <b>o</b>      The  message  is  subjected  again  to  mail
    156  1.1.1.1.2.2  snj                      address rewriting and substitution.  This is
    157  1.1.1.1.2.2  snj                      useful  when rewriting rules or virtual map-
    158  1.1.1.1.2.2  snj                      pings have changed.
    159  1.1.1.1.2.2  snj 
    160  1.1.1.1.2.2  snj                      The  address  rewriting  context  (local  or
    161  1.1.1.1.2.2  snj                      remote)  is the same as when the message was
    162  1.1.1.1.2.2  snj                      received.
    163  1.1.1.1.2.2  snj 
    164  1.1.1.1.2.2  snj               <b>o</b>      The message is subjected to  the  same  <a href="postconf.5.html#content_filter">con</a>-
    165  1.1.1.1.2.2  snj                      <a href="postconf.5.html#content_filter">tent_filter</a>  settings  (if  any) as used for
    166  1.1.1.1.2.2  snj                      new local mail submissions.  This is  useful
    167  1.1.1.1.2.2  snj                      when <a href="postconf.5.html#content_filter">content_filter</a> settings have changed.
    168  1.1.1.1.2.2  snj 
    169  1.1.1.1.2.2  snj               Warning:  Postfix queue IDs are reused.  There is a
    170  1.1.1.1.2.2  snj               very small possibility that  <a href="postsuper.1.html"><b>postsuper</b>(1)</a>  requeues
    171  1.1.1.1.2.2  snj               the  wrong  message  file when it is executed while
    172  1.1.1.1.2.2  snj               the Postfix mail system is  running,  but  no  harm
    173  1.1.1.1.2.2  snj               should be done.
    174  1.1.1.1.2.2  snj 
    175  1.1.1.1.2.2  snj               This feature is available in Postfix 1.1 and later.
    176  1.1.1.1.2.2  snj 
    177  1.1.1.1.2.2  snj        <b>-s</b>     Structure check and structure repair.  This  should
    178  1.1.1.1.2.2  snj               be done once before Postfix startup.
    179  1.1.1.1.2.2  snj 
    180  1.1.1.1.2.2  snj               <b>o</b>      Rename  files  whose name does not match the
    181  1.1.1.1.2.2  snj                      message file inode number. This operation is
    182  1.1.1.1.2.2  snj                      necessary  after restoring a mail queue from
    183  1.1.1.1.2.2  snj                      a different machine, or from backup media.
    184  1.1.1.1.2.2  snj 
    185  1.1.1.1.2.2  snj               <b>o</b>      Move queue files that are in the wrong place
    186  1.1.1.1.2.2  snj                      in the file system hierarchy and remove sub-
    187  1.1.1.1.2.2  snj                      directories that are no longer needed.  File
    188  1.1.1.1.2.2  snj                      position  rearrangements are necessary after
    189  1.1.1.1.2.2  snj                      a  change  in  the  <b><a href="postconf.5.html#hash_queue_names">hash_queue_names</a></b>  and/or
    190  1.1.1.1.2.2  snj                      <b><a href="postconf.5.html#hash_queue_depth">hash_queue_depth</a></b> configuration parameters.
    191  1.1.1.1.2.2  snj 
    192  1.1.1.1.2.2  snj        <b>-v</b>     Enable verbose logging for debugging purposes. Mul-
    193  1.1.1.1.2.2  snj               tiple <b>-v</b> options  make  the  software  increasingly
    194  1.1.1.1.2.2  snj               verbose.
    195  1.1.1.1.2.2  snj 
    196  1.1.1.1.2.2  snj <b>DIAGNOSTICS</b>
    197  1.1.1.1.2.2  snj        Problems  are reported to the standard error stream and to
    198  1.1.1.1.2.2  snj        <b>syslogd</b>(8).
    199  1.1.1.1.2.2  snj 
    200  1.1.1.1.2.2  snj        <a href="postsuper.1.html"><b>postsuper</b>(1)</a> reports the number of messages  deleted  with
    201  1.1.1.1.2.2  snj        <b>-d</b>,  the number of messages requeued with <b>-r</b>, and the num-
    202  1.1.1.1.2.2  snj        ber of messages whose queue file name was fixed  with  <b>-s</b>.
    203  1.1.1.1.2.2  snj        The  report is written to the standard error stream and to
    204  1.1.1.1.2.2  snj        <b>syslogd</b>(8).
    205  1.1.1.1.2.2  snj 
    206  1.1.1.1.2.2  snj <b>ENVIRONMENT</b>
    207  1.1.1.1.2.2  snj        MAIL_CONFIG
    208  1.1.1.1.2.2  snj               Directory with the <a href="postconf.5.html"><b>main.cf</b></a> file.
    209  1.1.1.1.2.2  snj 
    210  1.1.1.1.2.2  snj <b>BUGS</b>
    211  1.1.1.1.2.2  snj        Mail that is not sanitized by Postfix (i.e.  mail  in  the
    212  1.1.1.1.2.2  snj        <b>maildrop</b> queue) cannot be placed "on hold".
    213  1.1.1.1.2.2  snj 
    214  1.1.1.1.2.2  snj <b>CONFIGURATION PARAMETERS</b>
    215  1.1.1.1.2.2  snj        The  following  <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant
    216  1.1.1.1.2.2  snj        to this program.  The text below provides only a parameter
    217  1.1.1.1.2.2  snj        summary.  See <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including exam-
    218  1.1.1.1.2.2  snj        ples.
    219  1.1.1.1.2.2  snj 
    220  1.1.1.1.2.2  snj        <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
    221  1.1.1.1.2.2  snj               The default location of  the  Postfix  <a href="postconf.5.html">main.cf</a>  and
    222  1.1.1.1.2.2  snj               <a href="master.5.html">master.cf</a> configuration files.
    223  1.1.1.1.2.2  snj 
    224  1.1.1.1.2.2  snj        <b><a href="postconf.5.html#hash_queue_depth">hash_queue_depth</a> (1)</b>
    225  1.1.1.1.2.2  snj               The  number of subdirectory levels for queue direc-
    226  1.1.1.1.2.2  snj               tories listed with the <a href="postconf.5.html#hash_queue_names">hash_queue_names</a>  parameter.
    227  1.1.1.1.2.2  snj 
    228  1.1.1.1.2.2  snj        <b><a href="postconf.5.html#hash_queue_names">hash_queue_names</a> (deferred, defer)</b>
    229  1.1.1.1.2.2  snj               The  names  of  queue  directories  that  are split
    230  1.1.1.1.2.2  snj               across multiple subdirectory levels.
    231  1.1.1.1.2.2  snj 
    232  1.1.1.1.2.2  snj        <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
    233  1.1.1.1.2.2  snj               The location of the Postfix top-level queue  direc-
    234  1.1.1.1.2.2  snj               tory.
    235  1.1.1.1.2.2  snj 
    236  1.1.1.1.2.2  snj        <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
    237  1.1.1.1.2.2  snj               The syslog facility of Postfix logging.
    238  1.1.1.1.2.2  snj 
    239  1.1.1.1.2.2  snj        <b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b>
    240  1.1.1.1.2.2  snj               The  mail  system  name  that  is  prepended to the
    241  1.1.1.1.2.2  snj               process name in syslog  records,  so  that  "smtpd"
    242  1.1.1.1.2.2  snj               becomes, for example, "postfix/smtpd".
    243  1.1.1.1.2.2  snj 
    244  1.1.1.1.2.2  snj <b>SEE ALSO</b>
    245  1.1.1.1.2.2  snj        <a href="sendmail.1.html">sendmail(1)</a>, Sendmail-compatible user interface
    246  1.1.1.1.2.2  snj        <a href="postqueue.1.html">postqueue(1)</a>, unprivileged queue operations
    247  1.1.1.1.2.2  snj 
    248  1.1.1.1.2.2  snj <b>LICENSE</b>
    249  1.1.1.1.2.2  snj        The  Secure  Mailer  license must be distributed with this
    250  1.1.1.1.2.2  snj        software.
    251  1.1.1.1.2.2  snj 
    252  1.1.1.1.2.2  snj <b>AUTHOR(S)</b>
    253  1.1.1.1.2.2  snj        Wietse Venema
    254  1.1.1.1.2.2  snj        IBM T.J. Watson Research
    255  1.1.1.1.2.2  snj        P.O. Box 704
    256  1.1.1.1.2.2  snj        Yorktown Heights, NY 10598, USA
    257  1.1.1.1.2.2  snj 
    258  1.1.1.1.2.2  snj                                                                   POSTSUPER(1)
    259  1.1.1.1.2.2  snj </pre> </body> </html>
    260