The clean sub-command holds or deletes message files containing specific substrings in their envelope From: address, Subject: line, or content.
Available in both interactive and non-interactive modes.
clean [-content=substring] [-from=substring] [-subject=substring] [-to=substring] [-domain_to=substring] [-database | -directory_tree] [-delete | -hold] [-ignore_zz] [-match=keyword] [-min_length=n] [-threads=n | -nothreads] [-verbose | -noverbose] [channel] |
The options for this sub-command are:
Option |
Description |
---|---|
-content=substring -from=substring -subject=substring -to=substring -domain_to=substring |
Specifies the substrings for which to search. Any combination of each option may be used. However, only one of each may only be used. When a combination of such options is used, the -match option controls whether the options are interpreted as further restrictions (-match=AND), or as alternatives (-match=OR). The -domain_to option scans for frequently occurring envelope To: addresses. Identical to the -to option, except -domain_to looks at only the host.domain portion of the envelope To: address. The -from option can take an empty address using, for example, imsimta qm clean -from=\<\>. |
-database | -directory_tree |
Controls whether the message files searched are only those with entries in the queue cache (-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 sub-command will be used. If no view sub-command has been issued, then -directory_tree is assumed. |
-delete | -hold |
Specifies whether matching message files are held (-hold) or deleted (-delete). The -hold option is the default. |
-ignore_zz |
Ignores queued message files with file names beginning with “ZZ”. This option may be used to scan only those message files which represent queued messages which have failed at least one delivery attempt. |
-match=keyword |
Controls whether a message file must contain all (-match=AND) or only one of (-match=OR) the specified substrings in order to be held or deleted. The substrings are specified by the -content, -env_from, and -subject options. The default is -match=AND. |
-min_length=n |
Overrides the length limit for each substring to be searched. By default, the limit is 24 bytes (-min_length=24). |
-threads=n | -nothreads |
Accelerates the searching on multiprocessor systems by dividing the work amongst multiple, simultaneous running threads. To run n simultaneous searching threads, specify -threads=n. The value n must be an integer between 1 and 8. The default is -nothreads. |
-verbose | -noverbose |
Requests that the utility displays operation information (-verbose). The default is -noverbose. |
channel |
Specifies a specific MTA channel area to be searched for matching messages. The * or ? wildcard characters may be used in the channel specification. |