pmailq/pmailq.pod

=head1 NAME

pmailq - Postfix MAIL Queue manager

=head1 SYNOPSIS

pmailq [I<OPTION>]... [I<COMMAND>]

pmailq B<--help>

=head1 DESCRIPTION

pmailq parses output of B<mailq> command from postfix (ie: I<postqueue -p>) and permits
to perform some actions (like removing or displaying in a machine readable format) on
a bunch of entries in queue, selected by applying patterns on criterias like email
address, error message from smtp server, message size, mail status in queue.

=head1 COMMANDS

Action to perform on selected entries.

=over 2

=item B<list> (default command) 

show a detailed listing of the selected entries

=item B<parse> 

show a listing of the selected entries in a machine readable format

=item B<del> 

delete (via I<postsuper -d>) selected entries

=head1 OPTIONS

=over 2

=item B<-e> I<PATTERN>, B<--email>=I<PATTERN>

select entries in queue with email matching PATTERN (PATTERN accepts wildcards)

=item B<-m> I<PATTERN>, B<--msg>=I<PATTERN>

select entries in queue with error message matching PATTERN (PATTERN accepts wildcards)

=item B<-l> I<SIZE>, B<--size-lower>=I<SIZE>

select entries in queue with size lower than SIZE bytes

=item B<-u> I<SIZE>, B<--size-upper>=I<SIZE>

select entries in queue with size upper than SIZE bytes

=item B<-a>

select 'active' entries in queue

=item B<-o>

select 'on hold' entries in queue

=item B<--version>

show program's version number and exit

=item B<-h>, B<--help>

show this help message and exit

=head1 EXAMPLES

=over 1

Example n°1 : display all the mails in queue to "*@example.com*" with a size between 3000 and 3200 bytes in a machine readable format :

 # pmailq -u 3000 -l 3200 -e "*@example.com" parse
 7E75214643A4|Fri Aug 31|3154|1|0|edgar@example.com
 B0BDE146B640|Thu Aug 30|3199|1|0|paul@example.com
 B587E146B675|Wed Aug 29|3065|0|0|paul@example.com
 CF3C514656E4|Wed Aug 29|3161|0|0|abuse@example.com
      /\         /\       /\  \  \      
   queue id     date     size  \  \ on hold (or not)
                                \ active (or not)

Example n°2 : remove all mails in queue not sent because of a connection time out :

 # pmailq -m "*connection*timed*out" del
 deleting 00CF514616D3 [OK]
 deleting 12D911461924 [OK]
 deleting 269EF1461CA9 [OK]
 deleting 288DF1461CA0 [OK]
 deleting 3B3901460F62 [OK]
 deleting 3AE58147019F [OK]

=head1 SEE ALSO

L<postsuper(1)> privileged queue operations, L<postqueue(1)> mail queue control

=head1 AUTHOR

Emmanuel Bouthenot <kolter@openics.org>

=head1 COPYRIGHT AND LICENSE

Copyright 2007 by Emmanuel Bouthenot <kolter@openics.org>

This program is released under the "do What The Fuck you want to Public Licence"
Version 2, as published by Sam Hocevar.

See http://sam.zoy.org/wtfpl/COPYING for more details.

=cut