Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-QuarantineMessage

Exchange 2013
 

Applies to: Exchange Online Protection, Exchange Online

Topic Last Modified: 2014-01-09

This cmdlet is available only in the cloud-based service.

Use the Get-QuarantineMessage cmdlet to view quarantined messages in your cloud-based organization.

For information about the parameter sets in the Syntax section below, see Syntax.

Get-QuarantineMessage [-Direction <Inbound | Outbound>] [-Domain <String[]>] [-EndExpiresDate <DateTime>] [-EndReceivedDate <DateTime>] [-MessageId <String>] [-Page <Int32>] [-PageSize <Int32>] [-RecipientAddress <String[]>] [-Reported <$true | $false>] [-StartExpiresDate <DateTime>] [-StartReceivedDate <DateTime>] [-Subject <String>] [-Type <Spam | TransportRule>] <COMMON PARAMETERS>
Get-QuarantineMessage -Identity <String> <COMMON PARAMETERS>
COMMON PARAMETERS: [-Organization <OrganizationIdParameter>] [-SenderAddress <String[]>]

This example shows a summary list of messages quarantined between June 13, 2012 and June 15, 2012.

Get-QuarantineMessage -StartReceivedDate 06/13/2012 -EndReceivedDate 06/15/2012

This example shows the quarantine message with the Message-ID 5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com.

Get-QuarantineMessage -MessageID <5c695d7e-6642-4681-a4b0-9e7a86613cb7@contoso.com>

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 "Anti-spam" entry in the Feature Permissions in Exchange Online topic.

 

Parameter Required Type Description

Identity

Required

System.String

The Identity parameter specifies the quarantined message you want to view. The value of Identity is a unique message identifier that's used by the Get-QuarantineMessage and Release-QuarantineMessage cmdlets.

Direction

Optional

Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageDirectionEnum

The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound.

Domain

Optional

System.String[]

The Domain parameter filters the results by sender or recipient domain. You can specify multiple domain values separated by commas.

EndExpiresDate

Optional

System.DateTime

The EndExpiresDate parameter specifies the latest messages that will automatically be deleted from the quarantine. Use this parameter with the StartExpiresDate parameter.

Use the short date format defined in the Regional Options settings for the computer on which the command is run. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, you must enclose the argument in quotation marks ("), for example, "10/05/2010 5:00 PM".

For example, if you specify the StartExpiresDate value of today's date, and the EndExpiresDate value of the date three days from today, you will only see messages that will expire from the quarantine in the next three days.

EndReceivedDate

Optional

System.DateTime

The EndReceivedDate parameter specifies the latest messages to return in the results. Use this parameter with the StartReceivedDate parameter.

Use the short date format defined in the Regional Options settings for the computer on which the command is run. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, you must enclose the argument in quotation marks ("), for example, "10/05/2010 5:00 PM".

MessageId

Optional

System.String

The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

Page

Optional

System.Int32

The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1.

PageSize

Optional

System.Int32

The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000.

RecipientAddress

Optional

System.String[]

The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas.

Reported

Optional

System.Boolean

The Reported parameter filters the results by messages that have already been reported as false positives. Valid input for this parameter is $true or $false. When you specify the value $true, you only see quarantined messages that have already been reported as false positives. When you specify the value $false, you only see quarantined messages that haven't been reported as false positives.

SenderAddress

Optional

System.String[]

The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas.

StartExpiresDate

Optional

System.DateTime

The StartExpiresDate parameter specifies the earliest messages that will automatically be deleted from the quarantine. Use this parameter with the EndExpiresDate parameter.

Use the short date format defined in the Regional Options settings for the computer on which the command is run. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, you must enclose the argument in quotation marks ("), for example, "10/05/2010 5:00 PM".

For example, if you specify the StartExpiresDate value of today's date, and the EndExpiresDate value of the date three days from today, you will only see messages that will expire from the quarantine in the next three days.

StartReceivedDate

Optional

System.DateTime

The StartReceivedDate parameter specifies the earliest messages to return in the results. Use this parameter with the EndReceivedDate parameter.

Use the short date format defined in the Regional Options settings for the computer on which the command is run. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, you must enclose the argument in quotation marks ("), for example, "10/05/2010 5:00 PM".

Subject

Optional

System.String

The Subject parameter filters the results by the subject field of the message. If the value contains spaces, enclose the value in quotation marks (").

Type

Optional

Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageTypeEnum

The Type parameter filters the results by what caused the message to be quarantined. Valid values for this parameter are Spam and TransportRule.

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.

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.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.