PMDF System Manager's Guide
Previous Contents Index

directory

List currently queued messages.

Syntax

directory [channel-name]

Command Qualifiers Defaults
-database See text
-directory_tree See text
-envelope -noenvelope
-file_info -file_info
-from See text
-held -noheld
-match See text
-owner See text
-to See text
-total See text

Parameters

channel-name

An optional parameter specifying the channel for which to obtain a directory listing. Wildcards are permitted.

Description

The directory command is used to show the currently queued message files in either all channel queues or a particular channel queue. In the listing, message identification numbers will appear to the left of each message file name. These numbers may be used with the delete, history, hold, read, release, and return commands so as to identify which message to operate on.

The directory command produces its listing by looking at either the actual queue directory tree on disk, or by looking at the queue cache database. Use either the view command or the -directory_tree or -database qualifiers to control the source of information used. Note that when -directory_tree or view directory_tree is used, the "queued since" dates are the date and time that the message file was created; when -database or view database is used, the queued since dates are the date and time that the message was enqueued and may pre-date the actual creation date for the message file itself.

Qualifiers

-database

-directory_tree

Controls whether the information presented is gathered from the queue cache database, -database, or by looking at the actual directory tree containing the channel queues, -directory_tree. When neither -database or -directory_tree is specified, then the "view" selected with the view command will be used. If no view command has been issued, then -directory_tree is assumed.

-envelope

-noenvelope (default)

Use the -envelope qualifier to generate a directory listing including the envelope From: address and the list of envelope To: recipients for each listed message. By default, envelope information is not displayed as it involves opening each message file and reading through its envelope.

-file_info (default)

-nofile_info

By default, message file size and creation date information is gathered. However, this requires accessing each message file. Specify -nofile_info if you want to avoid that overhead.

-from=address

This qualifier may be used to request showing only those messages with the specified envelope From: address. This qualifier implies -envelope. To specify an empty (blank) envelope From: address, use -from=<>.

-held

-noheld (default)

Show information only for those channels with held messages.

-match=keyword

This qualifier controls the interpretation of the -from and -to qualifiers. Valid keywords are AND and OR.

-owner=username

This qualifier may be used to request showing only those message "owned" by the specified username. This qualifier implies -database. Note that messages submitted via SMTP with authentication (SMTP AUTH) will be considered to be owned by the username that authenticated, prefixed with the asterisk, *, character. For instance, if user jdoe submits a message from an IMAP client that successfully performs SMTP authentication, then PMDF QM will consider the owner of the message to be *jdoe, and to see such messages one would use the command 


qm.maint> dir -owner=*jdoe

-to=address

This qualifier may be used to request showing only those messages with the specified envelope To: address. This qualifier implies -envelope.

-total

This qualifier may be used to request showing only the total number of messages, rather than listing each individual message as is the default.

EXAMPLES


qm.maint> directory tcp_*
Fri, 15 Nov 2012 14:53:39 -0800 (PST)
Data gathered from the queue directory tree
Channel: tcp_local                Size Queued since
--------------------------------------------------------------
    1 ZL01HNM78RMBP496VPJS.00        4 12-Nov-2012 09:12:29.53
    2 ZM01HNMEDX5T8E96VQDN.00       10 12-Nov-2012 12:36:41.35
    3 ZX01HNP9IO1ZAM96W55R.00        6 15-Nov-2012 13:50:06.89
    4 ZY01HNP9HTAO9696W55R.00        5 15-Nov-2012 13:49:25.61
    5 ZY01HNPBGF8JVI96W55R.00        6 15-Nov-2012 14:45:34.33
    6 ZZ01HNPBFPQ4LG96W55R.00        5 15-Nov-2012 14:45:00.01
    7 ZZ01HNPBFQ4BS896W55R.00        5 15-Nov-2012 14:45:00.53
    8 ZZ01HNPBFR5KG296W55R.00        5 15-Nov-2012 14:45:01.92
    9 ZZ01HNPBFRD2IC96W55R.00        5 15-Nov-2012 14:45:02.19
   10 ZZ01HNPBFS7VP896W55R.00        5 15-Nov-2012 14:45:03.36
   11 ZZ01HNPBFTM8YY96W55R.00        5 15-Nov-2012 14:45:05.23
   12 ZZ01HNPBFY7JYU96W55R.00        5 15-Nov-2012 14:45:11.41
   13 ZZ01HNPBGL2BYC96W55R.00        5 15-Nov-2012 14:45:42.10
--------------------------------------------------------------
Total size:                         71
Channel: tcp_gateway              Size Queued since
--------------------------------------------------------------
    1 ZY01HNP9HYJ0QK96W55R.00        6 15-Nov-2012 13:49:32.60
    2 ZY01HNP9ID452296W55R.00        6 15-Nov-2012 13:49:52.18
    3 ZZ01HNPBFT1MAC96W55R.00        5 15-Nov-2012 14:45:04.47
    4 ZZ01HNPBGH5OAM96W55R.00        5 15-Nov-2012 14:45:36.85
    5 ZZ01HNPBGZO97C96W55R.00        5 15-Nov-2012 14:46:01.73
--------------------------------------------------------------
Total size:                         27
Grand total size:                   98
28 total messages queued
qm.maint>

This example shows how to use the directory command to list the messages queued to all channels whose names match the pattern "tcp_*"; i.e., all TCP/IP channels. 


qm.maint> directory -held
Fri, 15 Nov 2012 13:45:18 -0800 (PST)
Data gathered from the queue directory tree
Channel: tcp_local                Size Queued since
--------------------------------------------------------------
    1 ZZG01HNM78RMBP496VPJS.HELD    10 12-NOV-2012 23:31:18.34
    2 ZZM01HNMEDX5T8E96VQDN.HELD     8  8-NOV-2012 13:36:14.89
    3 ZZX01HNP9IO1ZAM96W55R.HELD    23 29-OCT-2012 07:27:49.01
--------------------------------------------------------------
Total size:                          41
Grand total size:                    41
3 total held messages queued
qm.maint>

In this example, the -held qualifier is used to check for held messages.

Previous Next Contents Index