Get-MailDetailTransportRuleReport
Applies to: Exchange Online, Exchange Online Protection
This cmdlet is available only in the cloud-based service.
Use the Get-MailDetailTransportRuleReport cmdlet to view the details of messages that matched the conditions defined by any transport rules.
For information about the parameter sets in the Syntax section below, see Syntax.
Get-MailDetailTransportRuleReport [-Action <MultiValuedProperty>] [-Direction <MultiValuedProperty>] [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-MessageId <MultiValuedProperty>] [-MessageTraceId <MultiValuedProperty>] [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] [-RecipientAddress <MultiValuedProperty>] [-SenderAddress <MultiValuedProperty>] [-StartDate <DateTime>] [-TransportRule <MultiValuedProperty>]
This example retrieves the details of messages sent by john@contoso.com that matched the conditions defined by a transport rule between June 13, 2015 and June 15, 2015.
Get-MailDetailTransportRuleReport -StartDate 06/13/2015 -EndDate 06/15/2015 -SenderAddress john@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 "View reports" entry in the Feature permissions in Exchange Online topic.
| Parameter | Required | Type | Description |
|---|---|---|---|
| Action | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering, or spam filtering. To view the complete list of valid values for this parameter, run the command You can specify multiple values separated by commas. |
| Direction | Optional | Microsoft.Exchange.Data.MultiValuedProperty |
The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are |
| Domain | Optional | Microsoft.Exchange.Data.MultiValuedProperty |
The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value |
| EndDate | Optional | System.DateTime | The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. 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, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM". |
| EventType | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The EventType parameter filters the report by the event type. To view the complete list of valid values for this parameter, run the command You can specify multiple values separated by commas. |
| Expression | Optional | System.Linq.Expressions.Expression | This parameter is reserved for internal Microsoft use. |
| MessageId | Optional | Microsoft.Exchange.Data.MultiValuedProperty |
The MessageId parameter filters the results by the |
| MessageTraceId | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. |
| 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. |
| ProbeTag | Optional | System.String | This parameter is reserved for internal Microsoft use. |
| RecipientAddress | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. |
| SenderAddress | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. |
| StartDate | Optional | System.DateTime | The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. 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, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM". |
| TransportRule | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The TransportRule parameter filters the report by the name of the transport rule. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). |
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.
