Get-MessageTrace
Applies to: Exchange Online, Exchange Online Protection
Topic Last Modified: 2016-10-10
This cmdlet is available only in the cloud-based service.
Use the Get-MessageTrace cmdlet to trace messages as they pass through the cloud-based organization.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Get-MessageTrace [-EndDate <DateTime>] [-Expression <Expression>] [-FromIP <String>] [-MessageId <MultiValuedProperty>] [-MessageTraceId <Guid>] [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] [-RecipientAddress <MultiValuedProperty>] [-SenderAddress <MultiValuedProperty>] [-StartDate <DateTime>] [-Status <MultiValuedProperty>] [-ToIP <String>]
This example retrieves message trace information for messages sent by john@contoso.com between June 13, 2015 and June 15, 2015.
Get-MessageTrace -SenderAddress john@contoso.com -StartDate 06/13/2015 -EndDate 06/15/2015
You can use this cmdlet to search message data for the last 7 days. If you run this cmdlet without any parameters, only data from the last 48 hours is returned.
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 |
|---|---|---|---|
| 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". |
| Expression | Optional | System.Linq.Expressions.Expression | This parameter is reserved for internal Microsoft use. |
| FromIP | Optional | System.String | The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. For outgoing messages from Exchange Online, the value is blank. |
| MessageId | Optional | Microsoft.Exchange.Data.MultiValuedProperty |
The MessageId parameter filters the results by the |
| MessageTraceId | Optional | System.Guid | 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. You can use wildcards in the format |
| 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. You can use wildcards in the format |
| 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". |
| Status | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The Status parameter filters the results by the delivery status of the message. Valid values for this parameter are:
|
| ToIP | Optional | System.String | The ToIP parameter filters the results by the destination IP address. For outgoing messages, the value of ToIP is the public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, the value is blank. |
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.
