exipick(8)

EXIPICK(8)                           EXIM4                          EXIPICK(8)

NAME
         exipick - selectively display messages from an Exim queue

SYNOPSIS
         exipick [<options>] [<criterion> [<criterion> ...]]
         exipick --help|--man

DESCRIPTION
       exipick is a tool to display messages in an Exim queue.  It is very
       similar to exiqgrep and is, in fact, a drop in replacement for
       exiqgrep.  exipick allows you to select messages to be displayed using
       any piece of data stored in an Exim spool file.  Matching messages can
       be displayed in a variety of formats.

QUICK START
       Delete every frozen message from queue:

           exipick -zi | xargs exim -Mrm

       Show only messages which have not yet been virus scanned:

           exipick '$received_protocol ne virus-scanned'

       Run the queue in a semi-random order:

           exipick -i --random | xargs exim -M

       Show the count and total size of all messages which either originated
       from localhost or have a received protocol of 'local':

           exipick --or --size --bpc \
                   '$sender_host_address eq 127.0.0.1' \
                   '$received_protocol eq local'

       Display all messages received on the MSA port, ordered first by the
       sender's email domain and then by the size of the emails:

           exipick --sort sender_address_domain,message_size \
                   '$received_port == 587'

       Display only messages whose every recipient is in the example.com
       domain, also listing the IP address of the sending host:

           exipick --show-vars sender_host_address \
                   '$each_recipients = example.com'

       Same as above, but show values for all defined variables starting with
       sender_ and the number of recipients:

           exipick --show-vars ^sender_,recipients_count \
                   '$each_recipients = example.com'

OPTIONS
       --and
           Display messages matching all criteria (default)

       -b  Display messages in brief format (exiqgrep)

       -bp | -l
           Display messages in standard mailq format (default).  (exiqgrep:
           "-l")

       -bpa
           Same as "-bp", show generated addresses also (exim)

       -bpc
           Show a count of matching messages (exim)

       -bpr
           Same as "-bp --unsorted" (exim)

       -bpra
           Same as "-bpa --unsorted" (exim)

       -bpru
           Same as "-bpu --unsorted" (exim)

       -bpu
           Same as "-bp", but only show undelivered messages (exim)

       -C | --config config
           Use config to determine the proper spool directory. (See "--spool"
           or "--input" for alternative ways to specify the directories to
           operate on.)

       -c  Show a count of matching messages (exiqgrep)

       --caseful
           Make operators involving "=" honor case

       --charset
           Override the default local character set for $header_ decoding

       -f regexp
           Same as "$sender_address =~ /<regexp>/" (exiqgrep).  Note that this
           preserves the default case sensitivity of exiqgrep's interface.

       --finput
           Same as "--input-dir Finput".  Finput is where exim copies frozen
           messages when compiled with SUPPORT_MOVE_FROZEN_MESSAGES.

       --flatq
           Use a single-line output format

       --freeze cache file
           Save queue information in an quickly retrievable format

       --help
           Display this output

       -i  Display only the message IDs (exiqgrep)

       --input-dir inputname
           Set the name of the directory under the spool directory.  By
           default this is input.  If this starts with /, the value of
           "--spool" is ignored.  See also "--finput".

       --not
           Negate all tests.

       -o seconds
           Same as "$message_age > <seconds>" (exiqgrep)

       --or
           Display messages matching any criteria

       --queue name
           Name of the queue (default: ''). See "named queues" in the spec.

       -r regexp
           Same as "$recipients =~ /<regexp>/" (exiqgrep).  Note that this
           preserves the default case sensitivity of exiqgrep's interface.

       --random
           Display messages in random order

       --reverse | -R
           Display messages in reverse order (exiqgrep: "-R")

       -s string
           Same as "$shown_message_size eq <string>" (exiqgrep)

       --spool path
           Set the path to the exim spool to use.  This value will have the
           arguments to "--queue", and "--input" or input appended, or be
           ignored if "--input" is a full path. If not specified, exipick uses
           the value from "exim [-C config] -n -bP spool_directory", and if
           this call fails, the  /opt/exim/spool from build time
           (Local/Makefile) is used. See also "--config".

       --show-rules
           Show the internal representation of each criterion specified

       --show-tests
           Show the result of each criterion on each message

       --show-vars variable[,variable...]
           Show the value for variable for each displayed message.  variable
           will be a regular expression if it begins with a circumflex.

       --size
           Show the total bytes used by each displayed message

       --thaw cache file
           Read queue information cached from a previous "--freeze" run

       --sort variable[,variable...]
           Display matching messages sorted according to variable

       --unsorted
           Do not apply any sorting to output

       --version
           Display the version of this command

       -x  Same as "!$deliver_freeze" (exiqgrep)

       -y  Same as "$message_age < EXIPICK(8)