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]

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

counters clear [-channels] [-associations]

-channels

Clears the message counters 

-associations

Clears the association counters 

counters create [-max_channels=n]

-max_channels=n

Tells the MTA how many channels to allow for in the memory segment. If this option is omitted, then the MTA looks at the imta.cnf file and determines a value on its own.

counters delete

counters show [-headers] [-noheaders] [-output=file-spec] \
[channel-name]

-headers or -noheaders

Controls whether or not a heading is displayed. The -headers option is the default.

-output=file_spec

Causes the output to be written to a file. Any existing file with the same name as the output file is overwritten. 

date

delete [-channel=name [-all]]  [-confirm | -noconfirm]
  [-log | -nolog] [id...]

directory [-held | -noheld]  [-database]  [-directory_tree]
  [-envelope]  [-owner=username] [-from=address] [-to=address]
  [-match=bool] [-file_info | -nofile_info] [-total | -nototal]
  [channel-name]

-database

Obtains message information from the Job Controller. 

-directory_tree

Selects the on-disk directory tree as the source of message information. 

-envelope

Generates a listing which also contains envelope address information. 

-total | -nototal

Generates size and count totals across all selected channels. 

-owner=username

Lists only those messages owned by a particular user. Messages enqueued by a local user will be owned by that user; most other messages will be owned by mailsrv. Use of the -owner option implies -database.

-from=address and -to=address and -match=bool

Lists only those messages with envelope From: or To: addresses matching the specified address. When both -from and -to are specified, a message is listed if either its envelope From: or To: addresses match the specified addresses. This corresponds to the -match=or option. Specify -match=and to list only messages matching both the specified From: and To: addresses. Use of -from or -to implies -envelope.

address can include a wild card (*) that matches a sequence of characters or a % character that matches a single character.

-held | -noheld

By default, active messages are listed. Specify -held to instead list messages which have been marked as held. Note that -held implies -directory_tree.

-file_info | -nofile_info

When the directory tree is scanned, each message file is accessed to determine its size as measured in units of blocks (normally 1024 bytes). To suppress this behavior and speed up generation of the listing, specify -nofile_info. When the queue cache database is used, the -nofile_info option is ignored as the size information is stored in the database.

channel-name

Restricts the listing to one or more channels. If the channel-name parameter is omitted, a listing is made for all channels. The channel name parameter may contain the * and ? wildcard characters.

exit

held [-envelope] [-file_info | -nofile_info]  [-total | -nototal]
  [-from=address] [-to=address] [-match=bool] [channel-name]

-envelope

Generates a listing which also contains envelope address information. 

-total | -nototal

Generate size and count totals across all selected channels. 

-from=address and

-to=address and

-match=bool

Lists only those messages with envelope From: or To: addresses matching the specified address. When both -from and -to are specified, a message is listed if either its envelope From: or To: addresses match the specified addresses. This corresponds to the -match=or option. Specify -match=and to list only messages matching both the specified From: and To: addresses. Use of -from or -to implies -envelope.

-file_info | -nofile_info

When the directory tree is scanned, each message file is opened to determine its size as measured in units of blocks (normally 1024 bytes). To suppress this behavior and speed up generation of the listing, specify -nofile_info.

channel-name

Restricts the listing to one or more channels. If the channel-name parameter is omitted, a listing is made for all channels. The channel-name parameter may contain the * and ? wildcard characters.

history [-channel=name [-all]  ]  [-confirm | -noconfirm] [id...]

hold [-channel=name [-all]] [-confirm | -noconfirm]
  [-log | -nolog] [id...]

jobs

channel <channel name>
        job <pid>
          host <host name>
          host <host name>
           <count of hosts> HOST BEING PROCESSED BY JOB <pid>
          message <subdir/message name>
          message <subdir/message name>
          processed messages: <# messages sucessfully dequeued>
          failed processing attempts: <#messages reenqueued>
          <count of messages> MESSAGES BEING PROCESSES BY JOB <pid>
         <count of jobs> JOBS ACTIVE FOR CHANNEL foo
       <count of active channels> ACTIVE CHANNELS

quit

read [-content | -nocontent ]  [-channel=name  [-all]]
  [-confirm | -noconfirm] [id...]

-content | -nocontent

Displays (-content) or suppresses display (-nocontent) of message content along with the envelope and header information. -nocontent is the default.

id

Specifies the messages to display. 

release [-channel=name [-all]]  [-confirm | -noconfirm]
  [-log | -nolog] [id...]

$ imsimta qm
qm maint> dir -held
qm maint> release 1

return [-channel=name [-all]]  [-confirm  | -noconfirm]
  [-log | -nolog] [id...]

run [-ignore | -noignore] [-log | -nolog]file-spec

-ignore | -noignore

Unless -ignore is specified, command execution will be aborted should one of the sub-commands generate an error.

-log | -nolog

By default, each command is echoed to the terminal before being executed (the -log option). Specify -nolog to suppress this echo.

startchannel

stop channel

summarize [-database | -directory_tree] [-heading | -noheading]
  [-held | -noheld] [-trailing | -notrailing]

-database | -directory_tree

Controls whether the information presented is obtained from the Job Controller (-database) or by looking at the actual directory tree containing the channel queues (-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.

-heading | -noheading

Controls whether or not a heading line describing each column of output is displayed at the start of the summary listing. The -heading option is the default.

-held | -noheld

Controls whether or not to include counts of .HELD messages in the output. The -noheld option is the default.

-trailing | -notrailing

Controls whether or not a trailing line with totals is displayed at the end of the summary. The -trailing option is the default.

top [-content[=range]] [-from[=range]] [-subject[=range]]
  [-to[=range]] [-database | -directory_tree] [-domain_to[=range]]
[-held] [-ignore_zz] [-min_count=n] [-threads=n | -nothreads]
[-top=n] [-verbose | -noverbose] [channel]

-content[=range]

-from[=range]

-subject[=range]

-to[=range]

-domain_to[=range]

The -content, -from, -subject, and -to options are used to specify which frequently occurring fields should be displayed. By default, only Subject: fields are shown (-subject). Use -from to display frequent envelope From: fields, -to to display frequent envelope To: fields, or -content to display frequent message contents. Use -domain_to to display frequently occurring envelope To: addresses. Identical to -to option, except -domain_to looks at only the host.domain portion of the envelope To: address.

Any combination of -content, -from, -to, -domain_to, and -subject may be specified. However, only one of each may be used. The -content, -from, -to, -domain_to, and -subject options accept the optional parameters START=n and LENGTH=n. These parameters indicate the starting position and number of bytes in the field to consider. The defaults are -content=(START=1,LENGTH=256), -from=(START=1,LENGTH=2147483647), -to=(START=1,LENGTH=2147483647), -subject=(START=1,LENGTH=2147483647), and -domain_to=(START=1,LENGTH=214783647). Use of these parameters is useful when, for example, trying to identify occurrences of a spam message which uses random text at the start of the Subject: line.

-database | -directory_tree

Controls whether the message files scanned 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 sub-command will be used. If no view sub-command has been issued, then -directory_tree is assumed.

-held

Lists only the files which have a .HELD extension.

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

-min_count=n

Changes the minimum number of times that a string must occur in order to be displayed. The default is -min_count=2.

-threads=n | -nothreads

Accelerates 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 between 1 and 8. The default is -nothreads.

-top=n

Changes the amount of most frequently occurring fields that are displayed. The default is -top=20.

-verbose | -noverbose

Requests that the utility displays operation information (-verbose). The default is -noverbose.

channel

Specifies an MTA channel area to be scanned for string frequencies. The * or? wildcard characters may be used in the channel specification. 

view -database | -directory_tree

version