Export (0) Print
Expand All
Expand Minimize
1 out of 1 rated this helpful - Rate this topic

Get-MessageTrace

Exchange 2013
 

Applies to: Exchange Online Protection, Exchange Online

Topic Last Modified: 2012-08-03

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 Syntax.

Get-MessageTrace [-EndDate <DateTime>] [-Expression <Expression>] [-FromIP <String>] [-MessageId <MultiValuedProperty>] [-MessageTraceId <Guid>] [-Organization <OrganizationIdParameter>] [-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, 2012 and June 15, 2012.

Get-MessageTrace -SenderAddress john@contoso.com -StartDate 06/13/2012 -EndDate 06/15/2012

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 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".

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 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.

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.

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.

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 *@contoso.com, user@* or *@*. However, if you use a value that contains wildcards, you can't specify any other values.

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 *@contoso.com, user@* or *@*. However, if you use a value that contains wildcards, you can't specify any other values.

StartDate

Optional

System.DateTime

The StartDate parameter specifies the start date of the date range.

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".

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:

  • None: The message has no delivery status because it was rejected or redirected to a different recipient.

  • Failed: Message delivery was attempted and it failed or the message was filtered as spam or malware, or by transport rules.

  • Pending: Message delivery is underway or was deferred and is being retried.

  • Delivered: The message was delivered to its destination.

  • Expanded: There was no message delivery because the message was addressed to a distribution group, and the membership of the distribution was expanded.

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.

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