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
1 – Parameters
channel-name
An optional parameter specifying the channel for which to obtain
a directory listing. Wildcards are permitted.
2 – Description
The HELD command is a synonym for the DIRECTORY/HELD command. See
the description of the DIRECTORY command for further information.
3 – Qualifiers
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.
3.2 /DIRECTORY_TREE
See /DATABASE
3.3 /ENVELOPE
Display envelope To: and From: for the held messages listed.
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.
3.5 /HELD
/HELD (default)
/NOHELD
Show information only for those channels with held messages.