VMS Help  —  PMDF  QM  Maintenance Mode Commands, 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

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  –  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.

3  –  Command Qualifiers

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).

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.

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.

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.

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.

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.

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.

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"

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
Close Help