Canceling messages

You can create a server management request to cancel messages in the server message store. You can create a one-time cancellation request or you can schedule your cancellation request to happen automatically. You can also optionally generate a report that details the messages that have been canceled.

Messages can only be canceled if they are in a non-final state and have not been transmitted to the recipient when the request is activated.

<CancelMessageRequest> subtags	Description
<request>	Groups information about a particular request. Specifying more than one <request> tag is equivalent to sending multiple separate server management requests.

<Request> subtags	Description
<condition>	Groups conditions for including a message to be canceled. See Condition tag.
<persistent>	Specifies that the request should be made persistent in the server database (so that messages can be canceled even if the server is restarted). Only used with schedules.
<requestId>	Specifies a unique identifier for the request that is included in each report generated as a result of this request. Using different values for this field allows more than one request to be active at the same time. Using the same request id allows the client to override or delete active requests.
<replyAddr>	The return address for each report generated as a result of this request. If this tag is omitted, the default return address of reports is the return address of the originating message.
<report>	Causes a report to be sent each time the request is activated. To cause a report to be sent each time the request is activated, put an empty <report> tag inside the <request> tag.
<schedule>	Specifies that the report should be generated on a schedule. See Server management request parent tags.

Example

This request cancels messages on the server with the address ianywhere.connector.myConnector\deadqueue:

<?xml version="1.0" encoding="UTF-8"?>
<actions>
 <CancelMessageRequest>
  <request>
   <requestId>cancelRequest</requestId>
   <condition>
    <customRule>ias_Address='ianywhere.connector.myConnector\deadqueue'</customRule>
   </condition>
  </request>
 </CancelMessageRequest>
</actions>

Discuss this page in DocCommentXchange.