Search-MessageTrackingReport

 

Applies to: Exchange Server 2016

Topic Last Modified: 2017-11-10

This cmdlet is available only in on-premises Exchange Server 2016.

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.

noteNote:
In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet 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>]]

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.

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

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.

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

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter scopes the search to the specified mailbox. You can use any value that uniquely identifies the mailbox.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

When you use this parameter without the Sender parameter, the specified mailbox is the message sender that's used in the search. You can specify the recipients by using the Recipients parameter.

When you use this parameter with the Sender parameter, the specified mailbox is message recipient that's used in the search.

Sender

Required

Microsoft.Exchange.Data.SmtpAddress

The Sender parameter specifies the email address of the message sender for messages that are sent to the mailbox that's specified by the Identity parameter.

You need to use this parameter with the Identity parameter.

BypassDelegateChecking

Optional

System.Management.Automation.SwitchParameter

The BypassDelegateChecking switch allows Help desk staff and administrators to track messages for any user. You don't need to specify a value with this switch.

By default, users can only track messages that they send or receive from their own mailbox.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

DoNotResolve

Optional

System.Management.Automation.SwitchParameter

The DoNotResolve switch specifies whether to prevent the resolution of email addresses to display names. You don't need to specify a value with this switch.

Using this switch improves performance, but the lack of display names might make the results more difficult to interpret.

MessageEntryId

Optional

System.String

This parameter is reserved for internal Microsoft use.

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.

Recipients

Optional

Microsoft.Exchange.Data.SmtpAddress[]

The Recipients parameter filters the results by the email addresses of the specified recipients. You can specify multiple email addresses separated by commas.

You can't use this parameter with the Sender parameter.

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 searches for messages with the specified Subject field value. If the value contains spaces, enclosed the value in quotation marks.

TraceLevel

Optional

Microsoft.Exchange.Management.Tracking.TraceLevel

The TraceLevel parameter specifies the details to include in the results. Valid values 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.

You only need to use this parameter for troubleshooting message tracking issues.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

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.

 
Show: