PMDF System Manager's Guide
PMDF-REF-6.0

Previous | Contents

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

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.

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, -directory_tree, or only those files with entries in the queue cache database, -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 searching threads, specify -threads=n. The value n must be in the range 1-8. The default is -nothreads.

COMMAND QUALIFIERS

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

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

-delete

-hold (default)

-hold is the default and means that matching message files will be held. Specify -delete to instead delete matching message files.

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

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

-threads=n

-nothreads (defaults)

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.

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

EXAMPLES

The following example shows holding all message files in the PMDF queue area that have the string "make money fast" in the Subject: header and have the string "spammers.com" in the envelope From: address. 

qm.maint> clean -subject="make money fast" env_from="spammers.com" -min_length=12
%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

Previous | Next | Contents