Qclean utility

Hold or delete message files from the MTA queue disk area that contain specified substrings in their envelope From address, Subject: header,  or message content.

Syntax
imsimta qclean &#x5b;channel&#x5d;

Restrictions
Privileges sufficient to read and delete files in the MTA channel queue directory tree, as well as read the  MTA queue cache database  (obtain information from the  Job Controller), are required.

Optional parameter which specifies a specific MTA 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. (Note that   message files  are not checked or affected by this  utility.) By default, message files are held. Specify  to instead delete matching message files. The,  ,   (synonym  ),   (synonym  ), and    switches are used to specify the substrings for  which to search. Often, the specific user recipient is not as relevant as the domain of the recipient(s), so the  switch is available for the purpose of specifying the recipient domain.

Any combination of,  ,   (synonym  ),    (synonym  ), and    may be specified. However, only one of each may be used. The  switch controls whether a message  file must contain all (, the default) or only  one of  the specified substrings in order to be  held or deleted. The default is.

By default, each substring to be searched for must be at least 24 bytes long. This is a safety measure: the longer the substring, the less likely the chance of false  "hits". Use the  switch to  override this limit, making sure to specify  before any switches specifying "short" strings. And note that only values for  of 5 or more  will be respected; attempting to set a   of less  than 5 will result in a value of 5 being used. Also by default, only message files identified by the  queue cache database are searched. Use the   switch to instead search all message files actually present in the  channel queue directory tree.

The optional channel parameter restricts the search to message files in the specified channel. The channel parameter may use  and    wild cards.

The  switch may be used to accelerate searching  on multiprocessor systems by dividing the work amongst multiple,  simultaneously running threads. To run   simultaneous searching threads, specify   . The value   must be in the range 1-8. The default is.

Note that this utility does not bother to update the Job Controller&#x27;s queue cache  regarding the  ing or deleting of message  files; the utility merely makes the change directly to the message file  on disk. (The Job Controller, when it happens to attempt to access and process such a modified or deleted message file, will see that the  message file no longer exists in its previous form and then update its  own data structure and continue on to process other messages.)

, ,     ,     ,     ,
The,  ,    (synonym  ),    (synonym  ), and    switches are used to specify the substrings for which to  search. Any combination of,  ,    (synonym  ),    (synonym  ), and   may be specified; explicit use of at least one such switch is required. However, only one occurrence of each such switch may be used. When a combination of such switches is used, the   switch controls whether  the switches are interpreted as further restrictions , or as alternatives.

(default),
The  switch, the default, specifies that only  message files identified by the  Job Controller&#x27;s queue cache be  searched. Use the  switch to instead  search all message files actually present in the channel queue  directory tree.

,  (default)
is the default and means that matching message files will be sidelined as   files. Specify  to instead delete  matching message files.

The default is, meaning that any criteria  specified by  ,  , and    switches must all match in order for the  current hold or delete operation to be applied. Specifying   means that a message will match as long as at  least one such criterion matches.

By default, each substring to be searched for must be at least 24 bytes long. This is a safety measure: the longer the substring, the less likely the chance of false  "hits". Use the  switch to  override this limit, making sure to specify  before any switches specifying "short" strings.

Note that the  value must be 5 or more;  attempting to set a smaller value will result in the value 5 being used.

,  (default)
The  switch may be used to accelerate searching  on multiprocessor systems by dividing the work amongst multiple,  simultaneously running threads. To run   simultaneous searching threads, specify    . The value    must be an integer in the range 1-8. The default is.

,  (default)
The  switch may be used to request that the  utility print out information about what it is doing as it operates.

Examples
%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 The above UNIX example shows holding all message files in the MTA queue area that have the string "make money fast" in the Subject:  header and have the string "spammers.com" in the envelope  From address.
 * 1) imsimta qclean -min_length=12 -subject="make money fast" -env_from="spammers.com"

See also:
 * Job Controller operation
 * Job Controller
 * MTA command line utilities