Applies to: Exchange Server 2013
Topic Last Modified: 2012-06-11
Use the Remove-Message cmdlet to delete a message from a queue on a Mailbox server or an Edge Transport server.
Syntax
Remove-Message -Filter <String> [-Server
<ServerIdParameter>] <COMMON PARAMETERS>
|
Remove-Message -Identity <MessageIdentity>
<COMMON PARAMETERS>
|
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]]
[-WhatIf [<SwitchParameter>]] [-WithNDR <$true |
$false>]
|
Examples
EXAMPLE 1
This example removes all messages that meet the following criteria without generating NDRs:
- The messages are sent by the sender Kweku@contoso.com.
- The messages are queued on the server Server1.
Copy Code | |
---|---|
Remove-Message -Server Server1 -Filter {FromAddress -eq "Kweku@contoso.com"} -WithNDR $false |
Detailed Description
A message being transmitted to multiple recipients
might be located in multiple queues. If you specify an
Identity parameter, the message is removed from a single
queue if that identity matches only a single message. If the
identity matches more than one message, you receive an error. To
remove a message from more than one queue in a single operation,
you must use the Filter parameter. If you try to remove a
message currently being delivered, the message status changes to
PendingDelete
. Message delivery isn't interrupted, but
if the delivery fails and causes the message to re-enter the queue,
it's then removed.
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 remove. The expression includes a property name followed by a comparison operator and value. The following message properties are valid criteria for the Filter parameter:
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
|
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
|
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:
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. |
WithNDR |
Optional |
System.Boolean |
The WithNDR parameter specifies whether a non-delivery
report (NDR) is returned to the sender of a message. The default
value is |
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.