Applies to: Exchange Server 2013

Topic Last Modified: 2012-06-13

Use the Suspend-Message cmdlet to prevent delivery of a particular message in a queue on a Mailbox server or an Edge Transport server.

Syntax

Suspend-Message -Filter <String> [-Server <ServerIdParameter>] <COMMON PARAMETERS>
Suspend-Message -Identity <MessageIdentity> <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example prevents delivery of all messages for which the following conditions are true:

  • The messages are sent by the sender Kweku@contoso.com.

  • The messages are queued on the server Server1.

Copy Code 
Suspend-Message -Server Server1 -Filter {FromAddress -eq "Kweku@contoso.com"}

Detailed Description

A message already in delivery won't be suspended. Delivery will continue and the message status will be PendingSuspend. If the delivery fails, the message will re-enter the queue and it will then be suspended. You can't suspend a message that's in the Submission queue or poison message queue.

A message being sent to multiple recipients might be located in multiple queues. If you specify an Identity parameter, the message is suspended in a single queue if that identity matches only a single message. If the identity matches more than one message, you receive an error. To suspend a message in more than one queue in a single operation, you must use the Filter parameter.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Queues" entry in the Mail Flow Permissions topic.

Parameters

Parameter Required Type Description

Filter

Required

System.String

The Filter parameter requires an expression that specifies the property value criteria for the messages that you want to suspend. The expression includes a property name followed by a comparison operator and value. The following message properties are valid criteria for the Filter parameter:

  • DateReceived: The date that the message was received.

  • ExpirationTime: The time that a message will expire.

  • FromAddress: The 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: The identity of the queue that holds the message. Enter the queue identity in the form of Server\destination, where destination is a routing destination or delivery group.

  • RetryCount: The number of times that delivery of a message to a destination was tried.

  • SCL: The spam confidence level (SCL) of the message. Valid SCL entries are the 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 email 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 aren't expressed as a single integer must be enclosed in quotation marks (").

Identity

Required

Microsoft.Exchange.Data.QueueViewer.MessageIdentity

The Identity parameter 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

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the Exchange server on which you want to run this command. You can use any value that uniquely identifies the server. For example:

  • Name

  • FQDN

  • Distinguished name (DN)

  • Exchange Legacy DN

If you don't use the Server parameter, the command is run on the local server.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.