Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2012-12-07

Use the Search-MessageTrackingReport cmdlet to find the unique message tracking report based on the search criteria provided. You can then pass this message tracking report ID to the Get-MessageTrackingReport cmdlet to get full message tracking information. For more information, see Get-MessageTrackingReport. The message tracking report cmdlets are used by the delivery reports feature.

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

Syntax

Search-MessageTrackingReport -Identity <MailboxIdParameter> -Sender <SmtpAddress> [-BypassDelegateChecking <SwitchParameter>] [-DoNotResolve <SwitchParameter>] [-MessageEntryId <String>] [-MessageId <String>] [-ResultSize <Unlimited>] [-Subject <String>] [-TraceLevel <Low | Medium | High>] <COMMON PARAMETERS>
Search-MessageTrackingReport -Identity <MailboxIdParameter> [-BypassDelegateChecking <SwitchParameter>] [-DoNotResolve <SwitchParameter>] [-MessageEntryId <String>] [-MessageId <String>] [-Recipients <SmtpAddress[]>] [-ResultSize <Unlimited>] [-Subject <String>] [-TraceLevel <Low | Medium | High>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example searches the message tracking report for messages sent from one user to another. This example returns the message tracking report for a message that David Jones sent to Wendy Richardson.

Copy Code 
Search-MessageTrackingReport -Identity "David Jones" -Recipients "wendy@contoso.com"

EXAMPLE 2

This example searches the message tracking report for the following scenario: The user Cigdem Akin was expecting an email message from joe@contoso.com that never arrived. She contacted the Help desk, which needs to generate the message tracking report on behalf of Cigdem and doesn't need to see the display names.

This example returns the message tracking reports that the Help desk can analyze to resolve the issue.

Copy Code 
Search-MessageTrackingReport -Identity "Cigdem Akin" -Sender "joe@contoso.com" -BypassDelegateChecking -DoNotResolve

Detailed Description

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 "Message tracking" entry in the Mail Flow Permissions topic.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the name of the mailbox for whom the message tracking report is being searched. The message tracking report only contains the tracking events related to the specified mailbox.

This parameter accepts the following values:

  • Alias

    Example: JPhillips

  • Canonical DN

    Example: Atlanta.Corp.Contoso.Com/Users/JPhillips

  • Display Name

    Example: Jeff Phillips

  • Distinguished Name (DN)

    Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com

  • Domain\Account

    Example: Atlanta\JPhillips

  • GUID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2

  • Immutable ID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com

  • Legacy Exchange DN

    Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips

  • SMTP Address

    Example: Jeff.Phillips@contoso.com

  • User Principal Name

    Example: JPhillips@contoso.com

Sender

Required

Microsoft.Exchange.Data.SmtpAddress

The Sender parameter specifies the email address of the message sender.

By default, this command searches for messages sent by the user specified in the Identity parameter. If you want to search the message tracking report for a message sent to the user, you must specify the email address of the sender of that message using this parameter.

BypassDelegateChecking

Optional

System.Management.Automation.SwitchParameter

The BypassDelegateChecking switch allows Help desk staff and administrators to track messages for any user. End-users can only track messages that they send or receive. You don't have to specify a value with this switch.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

DoNotResolve

Optional

System.Management.Automation.SwitchParameter

The DoNotResolve switch prevents the resolution of email addresses to display names. This improves performance, but the end result may not be as easy to interpret because it's missing the display names. You don't have to specify a value with this switch.

MessageEntryId

Optional

System.String

This parameter is reserved for internal Microsoft use.

MessageId

Optional

System.String

The MessageId parameter specifies the Internet message ID of the message for which you want to get the tracking report.

Recipients

Optional

Microsoft.Exchange.Data.SmtpAddress[]

The Recipients parameter specifies the recipients for whom you want to get the tracking report.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

Subject

Optional

System.String

The Subject parameter specifies text to be used to track messages that have the specified text in their subject lines.

TraceLevel

Optional

Microsoft.Exchange.Management.Tracking.TraceLevel

The TraceLevel parameter specifies whether additional trace details will be included in the output of the message tracking report. This parameter is intended to be used when troubleshooting message tracking issues.

The acceptable values for the TraceLevel parameter are:

  • Low   Minimal additional data is returned, including servers that were accessed, timing, message tracking search result counts, and any error information.

  • Medium   In addition to all the data returned for the Low setting, the actual message tracking search results are also returned.

  • High   Full diagnostic data is returned.

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.

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.