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.