Suspend Message operation


The Suspend Message process prevents delivery of a particular message in a queue on a computer that has Hub Transport server role or the Edge Transport server role installed. The following table describes the input parameters for Suspend Message process

Adapter request parameters for Suspend Message process

Element

Definition

Required

<Filter>

Requires an expression that specifies the property value criteria for the messages that you want to suspend

The expression includes a property name that is followed by a comparison operator and value.

The following message properties are valid criteria for the Filter parameter:

  • DateReceived (The date the message was received.)
  • ExpirationTime (The time a message will expire.)
  • FromAddress (The Simple Mail Transfer Protocol (SMTP) address of the sender of a message. This value is taken from MAIL FROM: in the message envelope.)
  • Identity (An integer that represents a particular message and an optional server and queue identity.)
  • InternetMessageId (The value of the MessageID: header field. This property is expressed as a GUID followed by the SMTP address of the sending server, as in this example: 67D7543D6103DC4FBEBA6BC7205DACABA61231@exchange.contoso.com.)
  • LastError (A text string of the last error recorded for a message.)
  • MessageSourceName (A text string of the name of the component that submitted this message to the queue.)
  • Queue (Specifies the identity of the queue that holds the message. Enter the queue identity in the form of Server\destination, where destination is a remote domain, mailbox server, or persistent queue name.)
  • RetryCount (The number of times delivery of a message to a destination was tried.)
  • SCL (The Spam Confidence Level (SCL) property specifies the SCL of the message. Valid SCL entries are integers 0 through 9. An empty SCL property value indicates that the message hasn't been processed by the Content Filter agent.)
  • Size (The size of a message.)
  • SourceIP (The IP address of the external server that submitted the message to the Exchange organization.)
  • Status (The current message status. Message status options are Active, Retry, Suspended, PendingSuspend, or PendingRemove.)
  • Subject (A text string that represents the e-mail subject. The value is taken from the Subject: header field. You can specify multiple filter criteria by using the "-" and comparison operator. Property values that are not expressed as a single integer must be enclosed in quotation marks.

Yes

<Identity>

Specifies the MessageIdentity integer that represents a particular message and an optional server and queue identity

The syntax for this parameter is as follows:

  • Server\QueueIdentity\MessageIdentity
  • QueueIdentity\MessageIdentity
  • Server*\MessageIdentity
  • MessageIdentity

Yes

<Server>

Specifies the name of the server to connect to by using Remote Procedure Call (RPC) that contains queues that hold the messages that you want to suspend

Enter the server name as a host name or a Fully Qualified Domain Name (FQDN). If this parameter is not used, the local server is queried.

No

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*