Filter

Required

System.String

The Filter parameter requires an expression that specifies the property value criteria for the messages that you want to remove. 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 that the message was received.
  
• ExpirationTime   The time that 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 Message-ID: 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 that delivery of a message to a destination was tried.
  
• SCL   The SCL property specifies the spam confidence level 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, and 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.

Identity

Required

Microsoft.Exchange.Data.QueueViewer.MessageIdentity

Use the Identity parameter to specify 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 parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm parameter.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

Use the Server parameter to specify the name of the server to connect to by using remote procedure call (RPC) that contains the queues that hold the messages that you want to remove. Enter the Server parameter as a host name or a fully qualified domain name (FQDN). If this parameter is not used, the local server is queried.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, 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 parameter.

WithNDR

Optional

System.Boolean

Use the WithNDR parameter to specify whether a non-delivery report (NDR) is returned to the sender of a message. The default behavior of this parameter is set to $true. This parameter can be used with both the Identity parameter and Filter parameter sets.