PMDF QM is a utility program which allows inspection and
manipulation of queued messages. PMDF QM has two modes:
maintenance mode and user mode. Maintenance mode can be used
to inspect and manipulate the channel queue directories and
the messages contained in them. Privileges sufficient to read,
create, and delete files in the channel queue directory tree as
well as read and update the queue cache database are required to
use maintenance mode. User mode is a very restricted version of
maintenance mode which allows unprivileged users to read their
own messages from the queues and to return them (bounce them)
back to their originator if desired. Users' own messages are
messages which they themselves have sent or were posted to a list
they own. They are not messages destined for the user. Users can
read or return any of their own queued messages, and, in the case
of outgoing PMDF-FAX messages, change FAX telephone numbers.
Note that this utility merely reports on messages in PMDF's
delivery queues. That a message you have sent no longer appears
in PMDF's queues, does not imply that it has reached its final
destination. All that it means is that the message has left the
PMDF system and is no longer under PMDF's control. For example,
it is not uncommon for a message to make an intermediate stop
on another system such as a mail hub. In such cases, PMDF will
consider the message to be "delivered" when it hands the message
and responsibility for it off to the intermediate system.
To run PMDF QM in user mode, issue the command
$ PMDF QM
To run PMDF QM in maintenance mode, issue the command
$ PMDF QM/MAINTENANCE
Use the EXIT or QUIT command to exit PMDF QM.
The commands accepted by this utility are described under the
User_mode_commands and Maintenance_mode_commands subtopics.
1 – User Mode Commands
1.1 – DATE
Show the current date and time.
Syntax
DATE
Command Qualifiers Defaults
None. None.
1.1.1 – Parameters
None.
1.1.2 – Description
The DATE command can be used to show the current date and time,
in RFC 822/1123 format - the same format as used in Internet-
style messages.
1.1.3 – Examples
In the following example, the current date and time in RFC
822/1123 format is displayed with the DATE command.
qm.user> DATE
Fri, 2 Aug 2012 13:34:16 PDT
qm.user>
1.2 – DIRECTORY
List currently queued messages.
Syntax
DIRECTORY [type]
Command Qualifiers Defaults
None. None.
1.2.1 – Parameters
type
An optional parameter specifying the type of messages to display
(e.g., FAX, INTERNET, CC:MAIL, etc.). Wild cards are permitted.
1.2.2 – Description
Use the DIRECTORY command to list any messages which you've sent
but which have not yet been delivered. The optional type argument
can be used to restrict the listing to certain types of messages
such as messages sent to the Internet or other TCP/IP connected
machines such as UNIX workstations, cc:Mail users, FAX machines,
etc. A complete list of the available types are shown below. You
can also use the ? key to obtain a listing of the available types
as shown in the examples below.
Type Message Types Listed
all_in_1 Messages sent to ALL-IN-1 users
bitnet Messages set to BITNET users
ccmail Messages sent to Lotus cc:Mail users
decnet Messages sent to DECnet users
fax Messages sent as FAXes via PMDF-FAX
groupwise Messages to GroupWise Office users
internet Messages sent to Internet users
local Messages sent to local VMS MAIL users
lotus_notes Messages sent to Lotus Notes users
mailbus_400 Messages sent to MAILbus 400 users
mailworks Messages sent to MailWorks users
message_ Messages sent to Message Router users
router
microsoft_ Messages sent to Microsoft Mail users
mail
netdata Messages sent to Netdata (PROFS) users
novell_mhs Messages sent to Novell MHS users
ovvm Messages sent to OV/VM (PROFS) users
pager Messages sent to personal pagers
popstore Messages sent to popstore users
snads Messages sent to SNADS users
tcpip Messages sent to TCP/IP users
teamlinks Messages sent to TeamLinks users
uucp Messages sent to UUCP users
wordperfect Messages sent to WordPerfect Office users
x400 Messages sent to X.400 users
In the directory listing, each message is assigned a message
identification number, or "message id" for short. The message id
appears in the leftmost column. These identification numbers can
be used with the READ, RETURN, and EDIT_FAX commands to identify
which messages to read, return, or edit.
It is important to note that when you send a message to more
than one recipient, the message might split into multiple message
copies. Consequently, the same message might appear multiple
times as being queued to different networks (or possibly even for
the same network). Such would be the case for a message sent both
to local users and remote users.
1.2.3 – Examples
1.qm.user> DIRECTORY ?
Optional keyword, must be chosen from:
(1) all_in_1 Messages sent to ALL-IN-1 users
(2) bitnet Messages sent to BITNET users
(3) ccmail Messages sent to cc:Mail users
(4) decnet Messages sent to DECnet users
(5) fax Messages sent as FAXes with PMDF-FAX
(6) groupwise Messages sent to GroupWise Office users
(7) internet Messages sent to Internet users
(8) local Messages sent to local users
(9) lotus_notes Messages sent to Lotus Notes users
(10) mailbus_400 Messages sent to MAILbus 400 users
(11) mailworks Messages sent to MailWorks users
(12) message_router Messages sent to Message Router users
(13) microsoft_mail Messages sent to Microsoft Mail users
(14) netdata Messages sent to Netdata (PROFS) users
(15) novell_mhs Messages sent to Novell MHS users
(16) ovvm Messages sent to OV/VM (PROFS) users
(17) pager Messages sent to personal pagers
(18) popstore Messages sent to popstore users
(19) snads Messages sent to SNADS users
(20) tcpip Messages sent to TCP/IP users
(21) teamlinks Messages sent to TeamLinks users
(22) uucp Messages sent to UUCP users
(23) wordperfect Messages sent to WordPerfect Office users
(24) x400 Messages sent to X.400 users
qm.user>
This example shows how to obtain a list of the recognized
message types. Whenever you are entering a command, you can
always press the question mark key, ?, to obtain help on what
to type next.
2.qm.user> DIRECTORY
Fri, 2 Aug 2012 18:49:40 PDT
Id Network From To Size Queued since
------------------------------------------------------------------------
1 Internet (TCP/IP) bob@example.com service@example.com 8 2-AUG 17:31
service@internode.co
2 Internet (TCP/IP) bob@example.com ietf-822@dimacs.rut 8 2-AUG 15:07
3 Internet (TCP/IP) bob@example.com mwalnut@cnri.reston 16 2-AUG 15:26
4 Internet (TCP/IP) bob@example.com jbakin@adoc.xerox.c 8 2-AUG 17:18
5 Internet (TCP/IP) bob@example.com klensin@MAIL1.RESTO 16 2-AUG 15:26
6 Internet (TCP/IP) bob@example.com MAILSERV@EXAMPLE.C 8 2-AIG 15:38
7 Internet (TCP/IP) bob@example.com john@EXAMPLE.COM 8 2-AUG 17:18
8 Message Router bob@example.com john%doof@am.naples. 8 2-AUG 12:25
9 Local delivery bob@example.com john 8 2-AUG 16:11
10 Internet (TCP/IP) bob@example.com mailserv@example.org 8 2-AUG 12:43
11 Internet (TCP/IP) bob@example.com MARKJOSEPH@delphi.com 8 2-AUG 15:07
--------------------------------------------------------------------------
Total size: 104
qm.user>
In this example, the DIRECTORY command is used to list all
queued messages. When a message has more than one envelope TO:
recipient, the additional recipients are shown on additional
lines of the listing as with message 1 which is addressed to
service@example.com and service@internode.com.au.
1.3 – EDIT_FAX
Edit a queued PMDF-FAX message.
Syntax
EDIT_FAX [message-id[,...]]
Qualifiers Defaults
/ALL /NOALL
/CONFIRM /NOCONFIRM
/LOG /LOG
1.3.1 – Parameters
message-id
A comma separated list of one or more message identification
numbers shown with a previous DIRECTORY command. Ranges are
allowed.
1.3.2 – Description
The addresses of queued FAX messages can be edited so as, for
instance, to correct a FAX telephone number. The messages to
be edited are specified by their message identification numbers
shown by the most recent DIRECTORY command. Those numbers appear
in the leftmost column of the DIRECTORY command listing.
1.3.3 – Qualifiers
1.3.3.1 /ALL
/ALL
/NOALL (default)
Edit all messages shown by the last DIRECTORY command.
Unless /NOCONFIRM is specified with /ALL, you will be required to
confirm any EDIT_FAX/ALL operation.
1.3.3.2 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
When /CONFIRM is specified, you will prompted to confirm each
message edit operation.
1.3.3.3 /LOG
/LOG (default)
/NOLOG
Specifies whether informational messages for each message edit
operation are generated.
1.4 – EXIT
Exit the PMDF QM utility.
Syntax
EXIT
Command Qualifiers Defaults
None. None.
1.4.1 – Parameters
None.
1.4.2 – Description
The EXIT and QUIT commands exit the PMDF QM utility.
1.5 – HELP
Obtain help on the use of PMDF QM.
Syntax
HELP [topic]
Command Qualifiers Defaults
None. None.
1.5.1 – Parameters
topic
Optional topic to obtain help on.
1.5.2 – Description
The HELP command can be used to obtain information on PMDF QM
commands. To obtain information on all of the PMDF QM commands,
use the command
qm.user> HELP
To obtain information on individual commands or topics use the
command
qm.user> HELP topic
where TOPIC is the name of the command or topic of interest.
1.6 – HISTORY
Display message history information.
Syntax
HISTORY [message-id[,...]]
Command Qualifiers Defaults
/ALL /NOALL
/CONFIRM /NOCONFIRM
1.6.1 – Parameters
message-id
A comma separated list of one or more message identification
numbers shown with a previous DIRECTORY command. Ranges are
allowed.
1.6.2 – Description
For many channels, delivery history information is appended
to the end of each message file after an unsuccessful delivery
attempt has been made. With the HISTORY command, this information
can be displayed.
The messages to show histories for are specified by their message
identification numbers shown by the most recent DIRECTORY
command. That number appears in the leftmost column of the
DIRECTORY command listing.
Note that history information is not recorded by some channels.
1.6.3 – Qualifiers
1.6.3.1 /ALL
/ALL
/NOALL (default)
Display history information for all messages shown with the last
DIRECTORY command.
1.6.3.2 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
When /CONFIRM is specified, you will be prompted to confirm
whether or not to display the history for each selected message.
1.7 – QUIT
Exit the PMDF QM utility.
Syntax
QUIT
Command Qualifiers Defaults
None. None.
1.7.1 – Parameters
None.
1.7.2 – Description
The EXIT and QUIT commands exit the PMDF QM utility.
1.8 – READ
Read a message.
Syntax
READ [message-id[,...]]
Qualifiers Defaults
/ALL /NOALL
/CONFIRM /NOCONFIRM
/CONTENT /CONTENT
1.8.1 – Parameters
message-id
A comma separated list of one or more message identification
numbers shown with a previous DIRECTORY command. Ranges are
allowed.
1.8.2 – Description
The READ command can be used to read one or more queued
messages. The messages to display are specified by their message
identification numbers shown by the most recent DIRECTORY
command. Those numbers appear in the leftmost column of the
DIRECTORY command listing.
1.8.3 – Qualifiers
1.8.3.1 /ALL
/ALL
/NOALL (default)
Display all messages shown with the last DIRECTORY command.
1.8.3.2 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
When /CONFIRM is specified, you will prompted to confirm whether
or not to display each selected message.
1.8.3.3 /CONTENT
/CONTENT (default)
/NOCONTENT
Specify /NOCONTENT if you only want to read the message envelope
and header.
1.8.4 – Examples
In the following example, message 3 is displayed.
qm.user> READ 3
Message id: 3
Transport layer information:
----------------------------------------------------------------------
Envelope From: address: doej@example.com
Envelope To: addresses: jones
Message header:
----------------------------------------------------------------------
Received: from EXAMPLE.COM by EXAMPLE.COM (PMDF V5.0-1 #8790)
id <01HNPFR0P5OW9D4GAS@EXAMPLE.COM> for BERNOULLI@EXAMPLE.COM; Fri,
02 Aug 2012 16:48:41 -0700 (PDT)
Date: Fri, 02 Aug 2012 16:48:40 -0700 (PDT)
From: John Doe <doej@example.com>
To: jones@example.com
Subject: sea voyage
Message-id: <01HNPFR12JYA9D4GAS@EXAMPLE.COM>
MIME-version: 1.0
Content-type: TEXT/PLAIN; CHARSET=US-ASCII
Content-transfer-encoding: 7BIT
Message content:
----------------------------------------------------------------------
Would you be interested in taking a short cruise to Nova Scotia?
- DoeJ
qm.user>
1.9 – RETURN
Return a message to its sender.
Syntax
RETURN [message-id[,...]]
Qualifiers Defaults
/ALL /NOALL
/CONFIRM /NOCONFIRM
/LOG /LOG
1.9.1 – Parameters
message-id
A comma separated list of one or more message identification
numbers shown with a previous DIRECTORY command. Ranges are
allowed.
1.9.2 – Description
Queued messages can be returned to their originator with the
RETURN command. The messages to be returned are specified by
their message identification numbers shown by the most recent
DIRECTORY command. Those numbers appear in the leftmost column of
the DIRECTORY command listing.
1.9.3 – Qualifiers
1.9.3.1 /ALL
/ALL
/NOALL (default)
Return all messages shown by the last DIRECTORY command. Unless
/NOCONFIRM is specified with /ALL, you will be required to
confirm any RETURN/ALL operation.
1.9.3.2 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
When /CONFIRM is specified, you will be prompted to confirm each
message return operation.
1.9.3.3 /LOG
/LOG (default)
/NOLOG
Specifies whether informational messages for each message return
operation are generated.
1.10 – SPAWN
Create a subprocess.
Syntax
SPAWN [command]
Qualifiers Defaults
/INPUT=in-file-spec None
/LOGICAL_NAMES /LOGICAL_NAMES
/OUTPUT=out-file-spec None
/PROCESS=name None
/SYMBOLS /SYMBOLS
/WAIT /WAIT
1.10.1 – Restrictions
Cannot be used from a captive account.
1.10.2 – Parameters
command
Optional parameter specifying the command string for the
subprocess to execute. After the command completes, the
subprocess terminates and control is returned to the parent
process.
1.10.3 – Description
The SPAWN command can be used to either issue a single DCL
command from within PMDF QM or to leave PMDF QM temporarily, do
other work (e.g., type out a file, generate a directory listing,
etc.), and then return to PMDF QM.
By default, the context of the current process is copied to the
subprocess. This behavior can be controlled with the /LOGICAL_
NAMES and /SYMBOLS qualifiers.
1.10.4 – Qualifiers
1.10.4.1 /INPUT
/INPUT=in-file-spec
Specifies an input command file from which the subprocess is to
draw command input. Once command processing is completed, the
subprocess terminates. When you specify both a command string and
input file, then the command string is first processed and then
the commands from the input file.
1.10.4.2 /LOGICAL_NAMES
/LOGICAL_NAMES (default)
/NOLOGICAL_NAMES
The /LOGICAL_NAMES qualifier specifies that the logical names
of the parent process are to be copied to the subprocess. This
is the default behavior. Specify /NOLOGICAL_NAMES to prevent the
subprocess from inheriting the logical name definitions of its
parent.
1.10.4.3 /OUTPUT
/OUTPUT=out-file-spec
Specifies the output file to which the output of the subprocess
is to be directed. If the /OUTPUT qualifier is omitted, then
subprocess output is directed to the current SYS$OUTPUT device
(generally, your terminal).
1.10.4.4 /PROCESS
/PROCESS=name
Specifies the process name to associate with the subprocess.
If not specified, a default name of the form USERNAME_n, where
"USERNAME" is your username, is used.
1.10.4.5 /SYMBOLS
/SYMBOLS (default)
/NOSYMBOLS
The /SYMBOLS qualifier specifies that the DCL symbol definitions
of the parent process are to be copied to the subprocess. This
is the default behavior. Specify /NOSYMBOLS to prevent the
subprocess from inheriting the symbol definitions of its parent.
1.10.4.6 /WAIT
/WAIT (default)
/NOWAIT
By default, your current (parent) process will wait until the
subprocess has finished its processing and terminated. This
default behavior is explicitly selected with the /WAIT qualifier.
The /NOWAIT qualifier allows you to continue working from your
current process while the subprocess is running. When you specify
/NOWAIT, you should also specify the /OUTPUT qualifier so as to
prevent the subprocess output from appearing on your terminal
screen.
1.10.5 – Examples
1.qm.user> SPAWN DIRECTORY/SIZE=ALL A.TXT
Directory D1:[BOB]
A.TXT;10 125/126
A.TXT;9 124/126
A.TXT;8 124/126
Total of 3 files, 373/378.
qm.user> SPAWN PURGE/LOG A.TXT
%PURGE-I-FILPURG, D1:[BOB]A.TXT;9 deleted (126 blocks)
%PURGE-I-FILPURG, D1:[BOB]A.TXT;8 deleted (126 blocks)
%PURGE-I-TOTAL, 2 files deleted (252 blocks)
qm.user>
In this example, the SPAWN command is used to obtain a
directory listing of the files A.TXT, and then to purge back
old versions of that file. The ability to do this is useful
when you find that you have insufficient disk quota to create
and edit a mail message you want to send.
2.qm.user> SPAWN
.
.
.
$ LOGOUT
Process BOB_1 logged out at 23-AUG-2012 12:12:51.42
qm.user>
In this example a SPAWN command with no command string is
issued. This places you into the subprocess where you can issue
DCL commands and perform other processing. When you are done
with the subprocess and ready to return to PMDF QM, use the
LOGOUT or EOJ command.
2 – Maintenance Mode Commands
2.1 – CLEAN
Hold or delete message files from the PMDF queue area that
contain specified substrings in their envelope From: address,
Subject: header, or message content.
Syntax
CLEAN [channel]
Command Qualifiers Defaults
/CONTENT=substring None
/DATABASE See text
/DELETE /HOLD
/DIRECTORY_TREE See text
/ENV_FROM=substring None
/HOLD /HOLD
/MATCH=keyword /MATCH=AND
/MIN_LENGTH=n /MIN_LENGTH=24
/SUBJECT=substring None
/THREADS=n /NOTHREADS
/VERBOSE /NOVERBOSE
2.1.1 – Parameters
channel
Optional parameter which specifies a specific PMDF channel area
to be searched for matching messages. * or ? wildcard characters
may be used in the channel specification.
2.1.2 – Description
Hold or delete message files containing specific substrings
in their envelope From: address, Subject: line, or content.
By default, message files are held (/HOLD). Specify /DELETE to
instead delete matching message files. The /CONTENT, /ENV_FROM,
and /SUBJECT qualifiers are used to specify the substrings for
which to search.
Any combination of /CONTENT, /ENV_FROM, and /SUBJECT may be
specified. However, only one of each may be used. The /MATCH
qualifier controls whether a message file must contain all
(/MATCH=AND, the default) or only one of (/MATCH=OR) the
specified substrings in order to be held or deleted. The default
is /MATCH=AND.
By default, each substring to be searched for must be at least
24 bytes long (/MIN_LENGTH=24). This is a safety measure:
the longer the substring, the less likely the chance of false
"hits". Use the /MIN_LENGTH qualifier to override this limit.
The message files searched may be either all those present in the
channel queue directory tree, or only those files with entries
in the queue cache database. Use either the VIEW command or the
/DIRECTORY_TREE or /DATABASE qualifier to control which files are
searched.
The optional channel parameter restricts the search to message
files in the specified channel. The channel parameter may use *
and ? wild cards.
The /THREADS qualifier may be used to accelerate searching on
multiprocessor systems by dividing the work amongst multiple,
simultaneously running threads. To run n simultaneous searchingg
threads, specify /THREADS=n. The value n must be in the range
1-8. The default is /NOTHREADS.
2.1.3 – Command Qualifiers
2.1.3.1 /CONTENT
/CONTENT=substring
/ENV_FROM=substring
/SUBJECT=substring
The /CONTENT, /ENV_FROM, and /SUBJECT qualifiers are used to
specify the substrings for which to search. Any combination of
/CONTENT, /ENV_FROM, and /SUBJECT may be specified. However, only
one of each may be used. When a combination of such qualifiers
is used, the /MATCH qualifier controls whether the qualifiers
are interpreted as further restrictions (/MATCH=AND), or as
alternatives (/MATCH=OR).
2.1.3.2 /DATABASE
/DATABASE
/DIRECTORY_TREE
Controls whether the message files searched are only those with
entries in the queue cache database, /DATABASE, or all message
files actually present in the channel queue directory tree,
/DIRECTORY_TREE.
When neither /DATABASE nor /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.
2.1.3.3 /DELETE
/DELETE
/HOLD (default)
/HOLD is the default and means that matching message files will
be held. Specify /DELETE to instead delete matching message
files.
2.1.3.4 /MATCH
/MATCH=keyword
The default is /MATCH=AND, meaning that any criteria specified
by /CONTENT, /ENV_FROM, and /SUBJECT qualifiers must all match
in order for the current hold or delete operation to be applied.
Specifying /MATCH=OR means that a message will match as long as
at least one such criterion matches.
2.1.3.5 /MIN_LENGTH
/MIN_LENGTH=n
By default, each substring to be searched for must be at least 24
bytes long (/MIN_LENGTH=24). This is a safety measure: the longer
the substring, the less likely the chance of false "hits". Use
the /MIN_LENGTH qualifier to override this limit.
2.1.3.6 /THREADS
/THREADS=n
/NOTHREADS (default)
The /THREADS qualifier may be used to accelerate searching on
multiprocessor systems by dividing the work amongst multiple,
simultaneously running threads. To run n simultaneous searching
threads, specify /THREADS=n. The value n must be an integer in
the range 1-8. The default is /NOTHREADS.
2.1.3.7 /VERBOSE
/VERBOSE
/NOVERBOSE (default)
The /VERBOSE qualifier may be used to request that the utility
print out information about what it is doing as it operates.
2.1.4 – Examples
The following example shows holding all message files in the
PMDF queue area that have the string "real estate" in the
Subject: header and have the string "ownership.com" in the
envelope From: address.
qm.maint> CLEAN/MIN_LENGTH=11/SUBJECT="real estate"
2.1.4.1 /ENV_FROM="ownership.com"
%QM-I-QCLISTING, building a list of message files to scan from the queue cache %QM-I-SCANNING, scanning 72 message files %QM-I-SCANNED, scanned 72 message files in 3.7500 seconds (19.20 messages/second) %QM-I-HELD, held 5 message files
2.2 – COUNTERS
2.2.1 – CLEAR
Clear the node-specific, in-memory cache of counters.
Syntax
COUNTERS CLEAR
Command Qualifiers Defaults
/ASSOCIATIONS /ASSOCIATIONS
/CHANNELS /CHANNELS
2.2.1.1 – Parameters
None.
2.2.1.2 – Description
To clear (zero) the counters in a node-specific, in-memory
cache, issue the COUNTERS CLEAR command on that particular node.
The command creates the node-specific, in-memory section of
association and channel counters if it does not already exist.
Then it zeros all fields in the in-memory section. Note that the
counters will be zeroed without first merging their values into
the cluster-wide database of channel counters. If a cluster-
wide, on-disk database does not already exist, a new one will be
created. Finally, the fields in the on-disk database for numbers
of stored messages, message recipients, and message volumes are
set based on the entries in the PMDF queue cache database.
Either the association counters, or channel counters, or both,
may be cleared. The default is to clear both association and
channel counters.
If you want to update the on-disk database with the old in-memory
values before clearing them, then you should issue a COUNTERS
SYNCHRONIZE command before issuing the COUNTERS CLEAR command.
2.2.1.3 – Command Qualifiers
2.2.1.3.1 /ASSOCIATIONS
/ASSOCIATIONS (default)
/NOASSOCIATIONS
This qualifier specifies whether to clear the in-memory cache of
association counters.
2.2.1.3.2 /CHANNELS
/CHANNELS (default)
/NOCHANNELS
This qualifier specifies whether to clear the in-memory cache of
channel counters.
2.2.2 – CRDB
Create a cluster-wide database of accumulated association and
channel counters.
Syntax
COUNTERS CRDB
Command Qualifiers Defaults
None. None.
2.2.2.1 – Parameters
None.
2.2.2.2 – Description
A new, cluster-wide database of channel counters can be created
with the COUNTERS CRDB command. The new database will have all
counters zeroed except for the count of messages stored in each
channel. Those counts will be determined by entries in the PMDF
queue cache database. In addition, if an in-memory section for
association and channel counters on this node does not already
exist, it will be created as well.
Once the on-disk, cluster-wide database exists, you may use
the COUNTERS SYNCHRONIZE command to merge the information from
the node-specific, in-memory cache of counters into the on-disk
database.
2.2.3 – SHOW
Display the contents of the cluster-wide database of channel
counters.
Syntax
COUNTERS SHOW [channel]
Command Qualifiers Defaults
/HEADER /HEADER
/OUTPUT=file-spec None
/SYNCHRONIZE /SYNCHRONIZE
/TIMEOUT=seconds /TIMEOUT=120
2.2.3.1 – Parameters
channel
Optional channel name indicating the channel(s) for which to show
counters. May contain wildcards.
2.2.3.2 – Description
The contents of the cluster-wide channel counter database may be
displayed with the COUNTERS SHOW command. By default, before the
counters are displayed, an implicit COUNTERS SYNCHRONIZE command
will be executed, to attempt to synchronize each node-specific
cache with the main cluster-wide database. Specify /NOSYNCHRONIZE
to merely display the current contents of the database without
first synchronizing the node-specific caches.
Note that SYSLCK privilege is required to perform the
synchronization step.
Note that the output of PMDF QM's COUNTERS SHOW command is
currently not as detailed as the output of the DCL level PMDF
COUNTERS/SHOW command.
2.2.3.3 – Command Qualifiers
2.2.3.3.1 /HEADER
/HEADER (default)
/NOHEADER
Controls whether or not a header line describing each column in
the table of counters is output.
2.2.3.3.2 /OUTPUT
/OUTPUT=file-spec
Direct the output to the specified file. By default the output
appears on your display.
2.2.3.3.3 /SYNCHRONIZE
/SYNCHRONIZE (default)
/NOSYNCHRONIZE
Before displaying the counters, attempt to synchronize each of
the node-specific caches with the cluster-wide database. Specify
/NOSYNCHRONIZE to skip this synchronization step.
2.2.3.3.4 /TIMEOUT
/TIMEOUT=seconds
By default, QM will wait upwards of 120 seconds for the node-
specific caches to be synchronized with the cluster-wide
database. Should the synchronization step not be completed before
the specified time period, then QM will stop waiting and proceed
to display the information from the database. You may specify a
different period of time to wait with the /TIMEOUT qualifier.
This qualifier has no effect when /NOSYNCHRONIZE is specified.
2.2.3.4 – Examples
To display the counters information for all TCP/IP channels,
use the command
qm.maint> COUNTERS SHOW *tcp_*
Channel Messages Recipients Blocks
------------------------ ---------- ---------- ----------
tcp_local
Received 33 41 95
Stored 0 0 0
Delivered 33 41 95
Submitted 1 1 3
tcp_internal
Received 632 758 1453
Stored 1 2 10
Delivered 631 756 1443
Submitted 3 6 12
qm.maint>
2.2.4 – SYNCHRONIZE
Synchronize each of the node-specific, in-memory caches of
channel counters with the cluster-wide database.
Syntax
COUNTERS SYNCHRONIZE
Command Qualifiers Defaults
/TIMEOUT=seconds /TIMEOUT=120
2.2.4.1 – Parameters
None.
2.2.4.2 – Description
To synchronize each of the node-specific, in-memory cache of
channel counters with the cluster-wide database, issue a COUNTERS
SYNCHRONIZE command. The command will not return control back
to you until either all the caches have been synchronized
or a "timeout" period has elapsed. Should the timeout period
elapse, then control will be returned to you. However, the
synchronization process will continue in the background. Use
the /TIMEOUT qualifier to adjust the timeout period which has a
default value of 120 seconds.
Note that SYSLCK privilege is required to use this command.
Note that the COUNTERS SYNCHRONIZE command signals each PMDF
counters synchronization process in the cluster to perform the
synchronization-there should be one such process on each node
running PMDF. Note that on each node, the synchronization can
only be performed if the PMDF counters synchronization process is
running on that node.
Assuming that the PMDF counters synchronization process is
running on each node, then for each node the node-specific, in-
memory cache will be created, if it does not already exist. If
the cluster-wide, on-disk database does not exist, it will be
created. The in-memory cache values will be used to update the
on-disk database, and then the on-disk database values for stored
messages, recipients, and volume will be set by scanning the PMDF
queue cache database.
2.2.4.3 – Command Qualifiers
2.2.4.3.1 /TIMEOUT
/TIMEOUT=seconds
By default, QM will wait upwards of 120 seconds for the node-
specific caches to be synchronized. Should the synchronizations
not be completed before the specified time period, QM will
return control to you prompting you for another command.
The synchronization process will, however, continue in the
background.
2.2.5 – TODAY
Display PMDF's count of the number of messages processed so far
today.
Syntax
COUNTERS TODAY
Command Qualifiers Defaults
None. None.
2.2.5.1 – Description
PMDF's count of the number of messages processed so far today may
be displayed with the COUNTERS TODAY command.
2.2.5.2 – Examples
This example illustrates displaying PMDF's count of the number
of messages processed so far today.
qm.maint> COUNTERS TODAY
4263 messages processed so far today
30000 messages per day are permitted by your license
qm.maint>
2.3 – DATE
Show the current date and time.
Syntax
DATE
Command Qualifiers Defaults
None. None.
2.3.1 – Parameters
None.
2.3.2 – Description
The DATE command may be used to show the current date and time,
in RFC 822 and RFC 1123 format. It is useful for placing time
stamps in log files for command procedures which periodically run
PMDF QM to check on PMDF's channel queues.
2.3.3 – Examples
qm.maint> DATE
Fri, 15 Nov 2012 13:34:16 PST
qm.maint>
2.4 – DELETE
Delete one or more messages from the channel queue directory.
Syntax
DELETE [message-id[,...]]
Command Qualifiers Defaults
/ALL /NOALL
/CHANNEL=name None
/CONFIRM /NOCONFIRM
/LOG /LOG
2.4.1 – Parameters
message-id[,...]
A comma separated list of one or more message identification
number or numbers shown by a previous DIRECTORY command. Ranges
are allowed.
2.4.2 – Description
The DELETE command is used to delete one or more messages from
the channel queue directories. The messages to be deleted are
specified by their message identification numbers shown by
the most recent DIRECTORY command. That number appears in the
leftmost column of the DIRECTORY command listing. Ambiguous
message numbers must be qualified by the proper channel name
with the /CHANNEL qualifier.
Note that the DELETE command irrevocably deletes each message
it is instructed to delete: the messages are not returned to
their originators nor will any further attempts to be made to
deliver them to their recipients. The messages are permanently
deleted. Often, it is preferable to use the RETURN command so as
to return the message to its originator, (e.g., bounce it back to
the sender).
2.4.3 – Qualifiers
2.4.3.1 /ALL
/ALL
/NOALL (default)
Delete all messages shown by the last DIRECTORY command. When
used in conjunction with the /CHANNEL qualifier, only those
messages shown by the last DIRECTORY command for the specified
channel will be deleted.
Unless /NOCONFIRM is specified with /ALL, you will be required to
confirm any DELETE/ALL operation.
2.4.3.2 /CHANNEL
/CHANNEL=name
Specifies the name of the channel from which to delete messages.
Wildcards are not permitted.
2.4.3.3 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
When /CONFIRM is specified, you will be prompted to confirm each
message delete operation.
2.4.3.4 /LOG
/LOG (default)
/NOLOG
Specifies whether informational messages for each message delete
operation are generated.
2.4.4 – Examples
In the following example, the DIRECTORY command is used to
list the messages in the local, l, channel. Then, the DELETE
command is used to delete messages 1, 3, 20, 21, and 22. A
range specification, 20-22, is used to specify message numbers
20, 21, and 22.
qm.maint> DIRECTORY L
Mon, 23 Sep 2012 13:43:39 PDT
Data gathered from the queue directory tree
Channel: l Size Queued since
--------------------------------------------------------------
1 ZZ01HNP17LSUWY9D4DNR.00 4 23-SEP-2012 01:10:23
2 ZZ01HNP1RP3B6G9D4DNR.00 10 23-SEP-2012 01:10:24
3 ZZ01HNP42MAMAI9D4DNR.00 3 23-SEP-2012 01:10:24
4 ZZ01HNP4MEWC8G9D4DNR.00 8 23-SEP-2012 06:18:57
...
24 ZZ01HNP90X63ZG9D4DNR.00 6 23-SEP-2012 13:21:14
--------------------------------------------------------------
Total size: 108
24 total messages queued
qm.maint> DELETE 1,3,20-22
%QM-I-DELETED, deleted the message file PMDF_QUEUE:[L]ZZ01HNP17LSUWY9D4DNR.00
%QM-I-DELETED, deleted the message file PMDF_QUEUE:[L]ZZ01HNP42MAMAI9D4DNR.00
%QM-I-DELETED, deleted the message file PMDF_QUEUE:[L]ZZ01HNP76RTGHY9D4DNR.00
%QM-I-DELETED, deleted the message file PMDF_QUEUE:[L]ZZ01HNP82HTXYB9D4DNR.00
%QM-I-DELETED, deleted the message file PMDF_QUEUE:[L]ZZ01HNP83JPOCV9D4DNR.00
qm.maint>
2.5 – 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
2.5.1 – Parameters
channel-name
An optional parameter specifying the channel for which to obtain
a directory listing. Wildcards are permitted.
2.5.2 – 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.
2.5.3 – Qualifiers
2.5.3.1 /DATABASE
/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 nor /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.
2.5.3.2 /DIRECTORY_TREE
See /DATABASE
2.5.3.3 /ENVELOPE
/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.
2.5.3.4 /FILE_INFO
/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.
2.5.3.5 /FROM
/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=<>.
2.5.3.6 /HELD
/HELD
/NOHELD (default)
Show information only for those channels with held messages.
2.5.3.7 /MATCH
/MATCH=keyword
This qualifier controls the interpretation of the /FROM and /TO
qualifiers. Valid keywords are AND and OR.
2.5.3.8 /OWNER
/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
2.5.3.9 /TO
/TO=address
This qualifier may be used to request showing only those messages
with the specified envelope To: address. This qualifier implies
/ENVELOPE.
2.5.3.10 /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.
2.5.4 – Examples
1.qm.maint> DIRECTORY *TCP_*
Mon, 23 Sep 2012 14:53:39 PST
Data gathered from the queue directory tree
Channel: tcp_local Size Queued since
--------------------------------------------------------------
1 ZL01HNM78RMBP496VPJS.00 4 21-SEP-2012 09:12:29.53
2 ZM01HNMEDX5T8E96VQDN.00 10 21-SEP-2012 12:36:41.35
3 ZX01HNP9IO1ZAM96W55R.00 6 21-SEP-2012 13:50:06.89
4 ZY01HNP9HTAO9696W55R.00 5 21-SEP-2012 13:49:25.61
5 ZY01HNPBGF8JVI96W55R.00 6 21-SEP-2012 14:45:34.33
6 ZZ01HNPBFPQ4LG96W55R.00 5 21-SEP-2012 14:45:00.01
7 ZZ01HNPBFQ4BS896W55R.00 5 21-SEP-2012 14:45:00.53
8 ZZ01HNPBFR5KG296W55R.00 5 21-SEP-2012 14:45:01.92
9 ZZ01HNPBFRD2IC96W55R.00 5 21-SEP-2012 14:45:02.19
10 ZZ01HNPBFS7VP896W55R.00 5 21-SEP-2012 14:45:03.36
11 ZZ01HNPBFTM8YY96W55R.00 5 21-SEP-2012 14:45:05.23
12 ZZ01HNPBFY7JYU96W55R.00 5 21-SEP-2012 14:45:11.41
13 ZZ01HNPBGL2BYC96W55R.00 5 21-SEP-2012 14:45:42.10
--------------------------------------------------------------
Total size: 71
Channel: mtcp_gateway Size Queued since
--------------------------------------------------------------
1 ZY01HNP9HYJ0QK96W55R.00 6 23-SEP-2012 13:49:32.60
2 ZY01HNP9ID452296W55R.00 6 23-SEP-2012 13:49:52.18
3 ZZ01HNPBFT1MAC96W55R.00 5 23-SEP-2012 14:45:04.47
4 ZZ01HNPBGH5OAM96W55R.00 5 23-SEP-2012 14:45:36.85
5 ZZ01HNPBGZO97C96W55R.00 5 23-SEP-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.
2.qm.maint> DIRECTORY/HELD
Mon, 23 Sep 2012 13:45:18 PST
Data gathered from the queue directory tree
Channel: tcp_local Size Queued since
--------------------------------------------------------------
1 ZZG01HNM78RMBP496VPJS.HELD 10 12-SEP-2012 23:31:18.34
2 ZZM01HNMEDX5T8E96VQDN.HELD 8 8-JUL-2012 13:36:14.89
3 ZZX01HNP9IO1ZAM96W55R.HELD 23 29-AUG-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.
2.6 – EDIT_FAX
Edit a queued PMDF-FAX message.
Syntax
EDIT_FAX [message-id[,...]]
Command Qualifiers Defaults
/ALL /NOALL
/CHANNEL=name None
/CONFIRM /NOCONFIRM
/LOG /LOG
2.6.1 – Parameters
message-id[,...]
A comma separated list of one or more message identification
numbers shown with a previous DIRECTORY command. Ranges are
allowed.
2.6.2 – Description
The addresses of queued FAX messages may be edited so as,
for instance, to correct an incorrect FAX telephone number.
The messages to be edited are specified by their message
identification numbers shown by the most recent DIRECTORY
command. That number appears in the leftmost column of the
DIRECTORY command listing. Ambiguous message numbers must be
qualified by the proper channel name with the /CHANNEL qualifier.
2.6.3 – Qualifiers
2.6.3.1 /ALL
/ALL
/NOALL (default)
Edit all messages shown by the last DIRECTORY command. When used
in conjunction with the /CHANNEL qualifier, only those messages
shown by the last DIRECTORY command for the specified channel
will be edited.
Unless /NOCONFIRM is specified with /ALL, you will be required to
confirm any EDIT_FAX/ALL operation.
2.6.3.2 /CHANNEL
/CHANNEL=name
Specifies the name of the channel from which to edit messages.
Wildcards are not permitted.
2.6.3.3 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
When /CONFIRM is specified, you will prompted to confirm each
message edit operation.
2.6.3.4 /LOG
/LOG (default)
/NOLOG
Specifies whether informational messages for each message edit
operation are generated.
2.7 – EXIT
Exit the PMDF QM utility.
Syntax
EXIT
Command Qualifiers Defaults
None. None.
2.7.1 – Parameters
None.
2.7.2 – Description
The EXIT and QUIT commands exit the PMDF QM utility.
2.8 – HELD
List currently queued messages which have been marked as held.
Syntax
HELD [channel-name]
Command Qualifiers Defaults
/DATABASE See text
/DIRECTORY_TREE See text
/ENVELOPE See text
/FILE_INFO /FILE_INFO
/HELD /HELD
2.8.1 – Parameters
channel-name
An optional parameter specifying the channel for which to obtain
a directory listing. Wildcards are permitted.
2.8.2 – Description
The HELD command is a synonym for the DIRECTORY/HELD command. See
the description of the DIRECTORY command for further information.
2.8.3 – Qualifiers
2.8.3.1 /DATABASE
/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.
2.8.3.2 /DIRECTORY_TREE
See /DATABASE
2.8.3.3 /ENVELOPE
Display envelope To: and From: for the held messages listed.
2.8.3.4 /FILE_INFO
/FILE_INFO
/NOFILE_INFO (default)
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.
2.8.3.5 /HELD
/HELD (default)
/NOHELD
Show information only for those channels with held messages.
2.9 – HELP
Obtain help on the use of PMDF QM.
Syntax
HELP [topic]
Command Qualifiers Defaults
None. None.
2.9.1 – Parameters
topic
Optional topic to obtain help on.
2.9.2 – Description
The HELP command may be used to obtain information on PMDF QM
commands. To obtain information on all of the PMDF QM commands,
use the command
qm.maint> HELP
To obtain information on individual commands or topics use the
command
qm.maint> HELP topic
where TOPIC is the name of the command or topic of interest.
2.10 – HISTORY
Display message history information.
Syntax
HISTORY [message-id[,...]]
Command Qualifiers Defaults
/ALL /NOALL
/CHANNEL=name None
/CONFIRM /NOCONFIRM
2.10.1 – Parameters
message-id[,...]
A comma separated list of one or more message identification
numbers shown with a previous DIRECTORY command. Ranges are
allowed.
2.10.2 – Description
For many channels, delivery history information is appended
to the end of each message file after an unsuccessful delivery
attempt has been made. With the HISTORY command, this information
can be displayed.
The messages to show histories for are specified by their message
identification numbers shown by the most recent DIRECTORY
command. That number appears in the leftmost column of the
DIRECTORY command listing. Ambiguous message numbers must be
qualified by the proper channel name with the /CHANNEL qualifier.
Note that history information is not recorded by some channels.
2.10.3 – Qualifiers
2.10.3.1 /ALL
/ALL
/NOALL (default)
Display history information for all messages shown with the last
DIRECTORY command. When used in conjunction with the /CHANNEL
qualifier, only histories of those messages shown with the last
DIRECTORY command for the specified channel will be shown.
2.10.3.2 /CHANNEL
/CHANNEL=name
Specifies the name of the channel for which to show message
histories. Wild cards are not permitted.
2.10.3.3 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
When /CONFIRM is specified, you will be prompted to confirm
whether or not to display the history for each selected message.
2.11 – HOLD
Mark one or more messages as being held.
Syntax
HOLD [message-id[,...]]
Command Qualifiers Defaults
/ALL /NOALL
/CHANNEL=name None
/CONFIRM /NOCONFIRM
/LOG /LOG
2.11.1 – Parameters
message-id[,...]
A comma separated list of one or more message identification
numbers shown with a previous DIRECTORY command. Ranges are
allowed.
2.11.2 – Description
Use the HOLD command to mark as held any messages which should
temporarily be placed on "hold". PMDF will not attempt to deliver
any messages which are marked as held. To resume processing of a
held message, use the RELEASE command. Messages which have been
held can be listed with the DIRECTORY/HELD command.
The messages to be held are specified by their message
identification numbers shown by the most recent DIRECTORY
command. That number appears in the leftmost column of the
DIRECTORY command listing. Ambiguous message numbers must be
qualified by the proper channel name with the /CHANNEL qualifier.
2.11.3 – Qualifiers
2.11.3.1 /ALL
/ALL
/NOALL (default)
Hold all messages shown by the last DIRECTORY command. When used
in conjunction with the /CHANNEL qualifier, only those messages
shown by the last directory command for the specified channel
will be held.
Unless /NOCONFIRM is specified with /ALL, you will be required to
confirm any HOLD/ALL operation.
2.11.3.2 /CHANNEL
/CHANNEL=name
Specifies the name of the channel from which to hold messages.
Wildcards are not permitted.
2.11.3.3 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
When /CONFIRM is specified, you will be prompted to confirm each
message hold operation.
2.11.3.4 /LOG
/LOG (default)
/NOLOG
Specifies whether informational messages for each message hold
operation are generated.
2.11.4 – Examples
In the following example, the DIRECTORY command is used to
list the messages in the local, l, channel. Then, the HOLD
command is used to hold messages 1, 3, 20, 21, and 22. A range
specification, 20-22, is used to specify message numbers 20,
21, and 22.
qm.maint> DIRECTORY L
Fri, 10 Mar 2012 13:43:39 PDT
Data gathered from the queue directory tree
Channel: l Size Queued since
--------------------------------------------------------------
1 ZZ01HNP17LSUWY9D4DNR.00 4 15-NOV-2012 01:10:23
2 ZZ01HNP1RP3B6G9D4DNR.00 10 10-MAR-2012 01:10:24
3 ZZ01HNP42MAMAI9D4DNR.00 3 10-MAR-2012 01:10:24
4 ZZ01HNP4MEWC8G9D4DNR.00 8 10-MAR-2012 06:18:57
...
24 ZZ01HNP90X63ZG9D4DNR.00 6 10-MAR-2012 13:21:14
--------------------------------------------------------------
24 total messages queued
qm.maint> HOLD 1,3,20-22
%QM-I-HELD, held the message file PMDF_QUEUE:[L]ZZ01HNP17LSUWY9D4DNR.00
%QM-I-HELD, held the message file PMDF_QUEUE:[L]ZZ01HNP42MAMAI9D4DNR.00
%QM-I-HELD, held the message file PMDF_QUEUE:[L]ZZ01HNP76RTGHY9D4DNR.00
%QM-I-HELD, held the message file PMDF_QUEUE:[L]ZZ01HNP82HTXYB9D4DNR.00
%QM-I-HELD, held the message file PMDF_QUEUE:[L]ZZ01HNP83JPOCV9D4DNR.00
qm.maint>
2.12 – QUIT
Exit the PMDF QM utility.
Syntax
QUIT
Command Qualifiers Defaults
None. None.
2.12.1 – Parameters
None.
2.12.2 – Description
The EXIT and QUIT commands exit the PMDF QM utility.
2.13 – READ
Display message envelope and header information.
Syntax
READ [message-id[,...]]
Command Qualifiers Defaults
/ALL /NOALL
/CHANNEL=name None
/CONFIRM /NOCONFIRM
/CONTENT /NOCONTENT
2.13.1 – Parameters
message-id[,...]
A comma separated list of one or more message identification
numbers shown with a previous DIRECTORY command. Ranges are
allowed.
2.13.2 – Description
The READ command may be used to display envelope and header
information for one or more queued messages. To also view the
message content, use the /CONTENT qualifier.
The messages to display are specified by their message
identification numbers shown by the most recent DIRECTORY
command. That number appears in the leftmost column of the
DIRECTORY command listing. Ambiguous message numbers must be
qualified by the proper channel name with the /CHANNEL qualifier.
2.13.3 – Qualifiers
2.13.3.1 /ALL
/ALL
/NOALL (default)
Display all messages shown with the last DIRECTORY command.
When used in conjunction with the /CHANNEL qualifier, only those
messages shown with the last DIRECTORY command for the specified
channel will be shown.
2.13.3.2 /CHANNEL
/CHANNEL=name
Specifies the name of the channel from which to display messages.
Wildcards are not permitted.
2.13.3.3 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
When /CONFIRM is specified, you will be prompted to confirm
whether or not to display each selected message.
2.13.3.4 /CONTENT
/CONTENT
/NOCONTENT (default)
When /CONTENT is specified, the content of the message will also
be shown.
2.13.4 – Examples
In the following example, the envelope and header information
for message number 1 is displayed.
qm.maint> READ 1
Filename: PMDF_QUEUE:[L]ZZ01HNPFR2FUN89D4GAS.00
Message id: 1
Transport layer information:
----------------------------------------------------------------------
Envelope From: address: fresnel@example.com
Envelope To: addresses: bernoulli
Message header:
----------------------------------------------------------------------
Received: from EXAMPLE.COM by EXAMPLE.COM (PMDF V6.1-1 #8790)
id <01HNPFR0P5OW9D4GAS@EXAMPLE.COM> for BERNOULLI@EXAMPLE.COM; Fri,
15 Nov 2012 16:48:41 -0700 (PDT)
Date: Fri, 15 Nov 2012 16:48:40 -0700 (PDT)
From: Fresnel the tabby cat <fresnel@example.com>
To: bernoulli@example.com
Subject: catnip and catnaps
Message-id: <01HNPFR12JYA9D4GAS@EXAMPLE.COM>
MIME-version: 1.0
Content-type: TEXT/PLAIN; CHARSET=US-ASCII
Content-transfer-encoding: 7BIT
qm.maint>
2.14 – RELEASE
Release one or more held messages.
Syntax
RELEASE [message-id[,...]]
Command Qualifiers Defaults
/ALL /NOALL
/CHANNEL=name None
/CONFIRM /NOCONFIRM
/LOG /LOG
2.14.1 – Parameters
message-id[,...]
A comma separated list of one or more message identification
numbers shown with a previous DIRECTORY/HELD command. Ranges are
allowed.
2.14.2 – Description
Use the RELEASE command to release any messages previously marked
as held, re-enter them in the queue cache database, and run the
associated channel so the messages can be processed. Messages
which have been held can be listed with the DIRECTORY/HELD
command.
The messages to be released are specified by their message
identification numbers shown by the most recent DIRECTORY
command. That number appears in the leftmost column of the
DIRECTORY command listing. Ambiguous message numbers must be
qualified by the proper channel name with the /CHANNEL qualifier.
2.14.3 – Qualifiers
2.14.3.1 /ALL
/ALL
/NOALL (default)
Release all messages shown by the last DIRECTORY/HELD command.
When used in conjunction with the /CHANNEL qualifier, only
those messages shown by the last DIRECTORY/HELD command for the
specified channel will be released.
Unless /NOCONFIRM is specified with /ALL, you will be required to
confirm any RELEASE/ALL operation.
2.14.3.2 /CHANNEL
/CHANNEL=name
Specifies the name of the channel from which to release messages.
Wildcards are not permitted.
2.14.3.3 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
When /CONFIRM is specified, you will be prompted to confirm each
message release operation.
2.14.3.4 /LOG
/LOG (default)
/NOLOG
Specifies whether informational messages for each message release
operation are generated.
2.14.4 – Examples
In the following example, the DIRECTORY/HELD command is used to
list held messages in the tcp_local channel. Then, the RELEASE
command is used to release all of the held messages from that
channel.
qm.maint> DIRECTORY/HELD TCP_LOCAL
Fri, 15 Nov 2012 13:43:39 PDT
Data gathered from the queue directory tree
Channel: tcp_local Size Queued since
--------------------------------------------------------------
1 ZZ01HNP17LSUWY9D4DNR.HELD 4 13-NOV-2012 03:12:00
2 ZZ01HNP1RP3B6G9D4DNR.HELD 10 14-NOV-2012 11:46:23
3 ZZ01HNP42MAMAI9D4DNR.HELD 5 14-NOV-2012 18:17:01
--------------------------------------------------------------
Total size: 19
3 total messages queued
qm.maint> RELEASE/ALL
Release all message files (Y/N, default is N)? YES
%QM-I-RELEASED, released the message file
PMDF_QUEUE:[TCP_LOCAL]ZZ01HNP17LSUWY9D4DNR.HELD
%QM-I-RELEASED, released the message file
PMDF_QUEUE:[TCP_LOCAL]ZZ01HNP1RP3B6G9D4DNR.HELD
%QM-I-RELEASED, released the message file
PMDF_QUEUE:[TCP_LOCAL]ZZ01HNP42MAMAI9D4DNR.HELD
qm.maint>
2.15 – RETURN
Return a message to its sender.
Syntax
RETURN [message-id[,...]]
Command Qualifiers Defaults
/ALL /NOALL
/CHANNEL=name None
/CONFIRM /NOCONFIRM
/LOG /LOG
2.15.1 – Parameters
message-id[,...]
A comma separated list of one or more message identification
numbers shown with a previous DIRECTORY command. Ranges are
allowed.
2.15.2 – Description
Queued messages may be returned to their originator with the
RETURN command. The messages to be returned are specified by
their message identification numbers shown by the most recent
DIRECTORY command. That number appears in the leftmost column of
the DIRECTORY command listing. Ambiguous message numbers must be
qualified by the proper channel name with the /CHANNEL qualifier.
The returned message is in two parts. The first part explains the
reason why the message is being returned; the text of the reason
is contained in the file RETURN_BOUNCED.TXT file located in the
PMDF language-specific directory. The second part of the returned
message contains the original message itself.
2.15.3 – Qualifiers
2.15.3.1 /ALL
/ALL
/NOALL (default)
Return all messages shown by the last DIRECTORY command. When
used in conjunction with the /CHANNEL qualifier, only those
messages shown by the last DIRECTORY command for the specified
channel will be returned.
Unless /NOCONFIRM is specified with /ALL, you will be required to
confirm any RETURN/ALL operation.
2.15.3.2 /CHANNEL
/CHANNEL=name
Specifies the name of the channel from which to return messages.
Wildcards are not permitted.
2.15.3.3 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
When /CONFIRM is specified, you will be prompted to confirm each
message return operation.
2.15.3.4 /LOG
/LOG (default)
/NOLOG
Specifies whether informational messages for each message return
operation are generated.
2.16 – SPAWN
Create a subprocess.
Syntax
SPAWN [command]
Command Qualifiers Defaults
/INPUT=in-file-spec None
/LOGICAL_NAMES /LOGICAL_NAMES
/OUTPUT=out-file-spec None
/PROCESS=name None
/SYMBOLS /SYMBOLS
/WAIT /WAIT
2.16.1 – Restrictions
Cannot be used from a captive account.
2.16.2 – Parameters
command
Optional parameter specifying the command string for the
subprocess to execute. After the command completes, the
subprocess terminates and control is returned to the parent
process.
2.16.3 – Description
The SPAWN command may be used to either issue a single DCL
command from within PMDF QM or to leave PMDF QM temporarily, do
other work (e.g., type out a file, generate a directory listing,
etc.), and then return to PMDF QM.
By default, the context of the current process is copied to the
subprocess. This behavior may be controlled with the /LOGICAL_
NAMES and /SYMBOLS qualifiers.
2.16.4 – Qualifiers
2.16.4.1 /INPUT
/INPUT=in-file-spec
Specifies an input command file from which the subprocess is to
draw command input. Once command processing is completed, the
subprocess terminates. When you specify both a command string and
input file, then the command string is first processed and then
the commands from the input file.
2.16.4.2 /LOGICAL_NAMES
/LOGICAL_NAMES (default)
/NOLOGICAL_NAMES
The /LOGICAL_NAMES qualifier specifies that the logical names
of the parent process are to be copied to the subprocess. This
is the default behavior. Specify /NOLOGICAL_NAMES to prevent the
subprocess from inheriting the logical name definitions of its
parent.
2.16.4.3 /OUTPUT
/OUTPUT=out-file-spec
Specifies the output file to which the output of the subprocess
is to be directed. If the /OUTPUT qualifier is omitted, then
subprocess output is directed to the current SYS$OUTPUT device
(generally, your terminal).
2.16.4.4 /PROCESS
/PROCESS=name
Specifies the process name to associate with the subprocess.
If not specified, a default name of the form USERNAME_n, where
"USERNAME" is your username, is used.
2.16.4.5 /SYMBOLS
/SYMBOLS (default)
/NOSYMBOLS
The /SYMBOLS qualifier specifies that the DCL symbol definitions
of the parent process are to be copied to the subprocess. This
is the default behavior. Specify /NOSYMBOLS to prevent the
subprocess from inheriting the symbol definitions of its parent.
2.16.4.6 /WAIT
/WAIT (default)
/NOWAIT
By default, your current (parent) process will wait until the
subprocess has finished its processing and terminated. This
default behavior is explicitly selected with the /WAIT qualifier.
The /NOWAIT qualifier allows you to continue working from your
current process while the subprocess is running. When you specify
/NOWAIT, you should also specify the /OUTPUT qualifier so as to
prevent the subprocess output from appearing on your terminal
screen.
2.16.5 – Examples
1.qm.maint> SPAWN DIRECTORY/SIZE=ALL a.txt
Directory D1:[BOB]
A.TXT;10 125/126
A.TXT;9 124/126
A.TXT;8 124/126
Total of 3 files, 373/378.
qm.maint> SPAWN PURGE/LOG a.txt
%PURGE-I-FILPURG, D1:[BOB]A.TXT;9 deleted (126 blocks)
%PURGE-I-FILPURG, D1:[BOB]A.TXT;8 deleted (126 blocks)
%PURGE-I-TOTAL, 2 files deleted (252 blocks)
qm.maint>
In this example, the SPAWN command is used to obtain a
directory listing of the files A.TXT, and then to purge back
old versions of that file. The ability to do this is useful
when you find that you have insufficient disk quota to create
and edit a mail message you want to send.
2.qm.maint> SPAWN
.
.
.
$ LOGOUT
Process BOB_1 logged out at 15-NOV-2012 12:12:51.42
qm.maint>
In this example a SPAWN command with no command string is
issued. This places you into the subprocess where you can issue
DCL commands and perform other processing. When you are done
with the subprocess and ready to return to PMDF QM, use the
LOGOUT or EOJ command.
2.17 – SUMMARIZE
Display a summary listing of message files.
Syntax
SUMMARIZE
Command Qualifiers Defaults
/DATABASE See text
/DIRECTORY_TREE See text
/HEADING /HEADING
/HELD /NOHELD
/TRAILING /TRAILING
2.17.1 – Parameters
None.
2.17.2 – Description
Display a summary listing of message files.
2.17.3 – Command Qualifiers
2.17.3.1 /DATABASE
/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.
2.17.3.2 /HEADING
/HEADING (default)
/NOHEADING
Controls whether or not a heading line describing each column of
output is displayed at the start of the summary listing.
2.17.3.3 /HELD
/HELD
/NOHELD (default)
Controls whether or not to include counts of .HELD messages in
the output.
2.17.3.4 /TRAILING
/TRAILING (default)
/NOTRAILING
Controls whether or not a trailing line with totals is displayed
at the end of the summary.
2.17.4 – Examples
The following example shows displaying a summary listing of
message files.
qm.maint> SUMMARIZE
Messages
Channel Queued Size (Kb) Oldest
-------------------------------- -------- ----------- -----------------
cc_local 0 0.00
circuitcheck 4 7.51 8 Jun, 10:19:20
conversion 0 0.00
l 0 0.00
mailserv 0 0.00
mime_to_x400 0 0.00
mr_local 0 0.00
popstore 0 0.00
process 0 0.00
reprocess 0 0.00
tcp_internal 15 51.47 2 Jun, 12:10:03
tcp_local 0 0.00
wpo_local 0 0.00
x400_local 0 0.00
x400_to_mime 0 0.00
-------------------------------- -------- ----------- -----------------
Totals 19 58.98
qm.maint>
2.18 – TOP
Display the most frequently occurring envelope From:, Subject:,
or message content fields found in message files in the channel
queues.
Syntax
TOP [channel]
Command Qualifiers Defaults
/CONTENT[=offset-specifier] None
/DATABASE See text
/DIRECTORY_TREE See text
/ENV_FROM[=offset-specifier] None
/MIN_COUNT=n /MIN_COUNT=2
/SUBJECT[=offset-specifier] /SUBJECT=(START=1,LENGTH=2147483647)
/THREADS=n /NOTHREADS
/TOP=n /TOP=20
/VERBOSE /NOVERBOSE
2.18.1 – Parameters
channel
Optional parameter which specifies a specific PMDF channel area
to be scanned for string frequencies. * or ? wildcard characters
may be used in the channel specification.
2.18.2 – Description
Display the most frequently occurring envelope From:, Subject:,
or message content fields found in message files in the channel
queues. By default, only Subject: fields are shown (/SUBJECT).
Use /ENV_FROM to display frequent envelope From: fields or
/CONTENT to display frequent message contents. Any combination
of /CONTENT, /ENV_FROM, and /SUBJECT may be specified. However,
only one of each may be used.
The optional channel parameter restricts the scan to message
files in the specified channel. The channel parameter may use *
and ? wild cards.
By default, the top 20 most frequently occurring fields are
shown (/TOP=20) provided that they occur 2 or more times (/MIN_
COUNT=2). Use the /TOP and /MIN_COUNT qualifiers to alter this
behavior. The message files searched may be either all those
present in the channel queue directory tree, or only those files
with entries in the queue cache database. Use either the VIEW
command of the /DIRECTORY_TREE or /DATABASE qualifier to control
which files are searched.
The /THREADS qualifier may be used to accelerate scanning on
multiprocessor systems by dividing the work amongst multiple,
simultaneously running threads. To run n simultaneous scanning
threads, specify /THREADS=n. The value N must be in the range
1-8. The default is /NOTHREADS.
The /CONTENT, /ENV_FROM, and /SUBJECT qualifiers accept the
optional qualifiers START=n and LENGTH=n. These qualifiers
indicate the starting offset and number of bytes in the field
to consider. The defaults are /CONTENT=(START=1,LENGTH=256),
/ENV_FROM=(START=1,LENGTH=2147483647), and
/SUBJECT=(START=1,LENGTH=2147483647). Use of these qualifiers
is useful when, for example, trying to identify occurrences of a
spam message which uses random text at the start of the Subject:
line.
2.18.3 – Command Qualifiers
2.18.3.1 /CONTENT
/CONTENT[=offset-specifier]
/ENV_FROM[=offset-specifier]
/SUBJECT[=offset-specifier]
The /CONTENT, /ENV_FROM, and /SUBJECT qualifiers are used to
specify which frequently occurring fields should be displayed. By
default, only Subject: fields are shown (/SUBJECT). Use /ENV_FROM
to display frequent envelope From: fields or /CONTENT to display
frequent message contents. Any combination of /CONTENT, /ENV_
FROM, and /SUBJECT may be specified. However, only one of each
may be used.
The /CONTENT, /ENV_FROM, and /SUBJECT qualifiers accept the
optional qualifiers START=n and LENGTH=n. These qualifiers
indicate the starting offset and number of bytes in the field
to consider. The defaults are /CONTENT=(START=1,LENGTH=256),
/ENV_FROM=(START=1,LENGTH=2147483647), and
/SUBJECT=(START=1,LENGTH=2147483647). Use of these qualifiers
is useful when, for example, trying to identify occurrences of a
spam message which uses random text at the start of the Subject:
line.
2.18.3.2 /DATABASE
/DATABASE
/DIRECTORY_TREE
Controls whether the message files scanned are only those with
entries in the queue cache database, /DATABASE, or all message
files actually present in the channel queue directory tree,
/DIRECTORY_TREE.
When neither /DATABASE nor /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.
2.18.3.3 /MIN_COUNT
/MIN_COUNT=n
By default, a string must occur at least 2 times, /MIN_COUNT=2,
in order to be displayed.
2.18.3.4 /THREADS
/THREADS=n
/NOTHREADS (default)
The /THREADS qualifier may be used to accelerate searching on
multiprocessor systems by dividing the work amongst multiple,
simultaneously running threads. To run n simultaneous searching
threads, specify /THREADS=n. The value n must be an integer in
the range 1-8. The default is /NOTHREADS.
2.18.3.5 /TOP
/TOP=n
By default, the top 20 most frequently occurring fields are
shown, (/TOP=20).
2.18.3.6 /VERBOSE
/VERBOSE
/NOVERBOSE (default)
The /VERBOSE qualifier may be used to request that the utility
print out information about what it is doing as it operates.
2.18.4 – Examples
The following example shows displaying the most frequently
occurring Subject: and envelope From: addresses amongst
messages in the PMDF queue area.
qm.maint> TOP/SUBJECT/ENV_FROM
%QM-I-QCLISTING, building a list of message files to scan from the queue cache
%QM-I-SCANNING, scanning 73 message files
%QM-I-SCANNED, scanned 73 message files in 0.5600 seconds (130.36 messages/secon
d)
Top 20 Envelope From: addresses which occur 2 or more times
Count Envelope From: address
27
10 owner-ex-list@example.com
2 owner-test-list@example.com
Top 20 Subject: header lines which occur 2 or more times
Count Subject
6 Re: your ex-list posting
2 Test posting to test-list
The following example shows displaying the most frequently
occuring Subject: lines that occur 20 times or more, starting
from 12 characters into the Subject: header value. This may be
useful when trying to spot spam that inserts random characters
at the beginning of the Subject: header value.
qm.maint> TOP/SUBJECT=START=12/MIN_COUNT=15
%QM-I-QCLISTING, building a list of message files to scan from the queue cache
%QM-I-SCANNING, scanning 73 message files
%QM-I-SCANNED, scanned 73 message files in 0.5600 seconds (130.36 messages/secon
d)
Top 20 Subject: header lines which occur 15 or more times
Count Subject
25 ake money fast $$$
2.19 – VIEW
Control whether the DIRECTORY command shows the channel queue
directory tree or the queue cache database.
Syntax
VIEW type
Command Qualifiers Defaults
None. None.
2.19.1 – Parameters
type
The type of view to use: DIRECTORY_TREE or DATABASE
2.19.2 – Description
The DIRECTORY command produces its listing by looking at either
the actual channel queue directory tree on disk, or by looking
at the queue cache database. The VIEW command controls which is
used. By default, the view is the channel queue directory tree.
Issue the command,
qm.maint> VIEW DATABASE
qm.maint>
to switch to viewing the queue cache database. The command
qm.maint> VIEW DIRECTORY_TREE
qm.maint>
will switch you back to viewing the channel queue directory tree.
Issuing the VIEW command without any parameter will restore the
default behavior and is thus equivalent to the VIEW DIRECTORY_
TREE command.