[This topic is in progress.]

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2011-09-08

Use the Get-MessageTrackingLog cmdlet to search message information stored in the message tracking log.

Syntax


`Get-MessageTrackingLog [-DomainController <Fqdn>] [-End <DateTime>] [-EventId <String>] [-InternalMessageId <String>] [-MessageId <String>] [-MessageSubject <String>] [-Recipients <String[]>] [-Reference <String>] [-ResultSize <Unlimited>] [-Sender <String>] [-Server <ServerIdParameter>] [-Start <DateTime>]`

Detailed Description

A unique message tracking log exists on each computer that has the Hub Transport server role, the Mailbox server role, or the Edge Transport server role installed. The message tracking log is a comma-separated value (CSV) file that contains detailed information about the history of each e-mail message as it travels through an individual server.

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 Transport Permissions topic.

Parameters

Parameter	Required	Type	Description
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. The DomainController parameter isn't supported on the Edge Transport server role. The Edge Transport server role reads only from the Active Directory Lightweight Directory Services (AD LDS) instance.
End	Optional	System.DateTime	The End parameter specifies the end date and time to return message tracking log entries. Entries are returned up to, but not including, the specified date and time. The date and time must be specified in the format mm/dd/yyyy hh:mm:ss. For example, 10/12/2011 12:00:00 returns results up to 12:00 pm, October 12, 2011.
EventId	Optional	System.String	The EventId parameter specifies the event categories to return message tracking log entries with. The following are possible event categories: `BadMail`, `Defer Deliver`, `DSN`, `Expand`, `Fail`, `PoisonMessage`, `Receive`, `Redirect`, `Resolve`, `Send`, `Submit`, and `Transfer`.
InternalMessageId	Optional	System.String	The InternalMessageId parameter specifies the message identifier of the message tracking log entries to return. The InternalMessageID parameter is a message identifier assigned by the computer running Microsoft Exchange Server 2010 currently processing the message. A specific message's value of the InternalMessageID parameter is different in the message tracking log of every Exchange 2010 server involved in the delivery of the message.
MessageId	Optional	System.String	The MessageId parameter specifies the `Message-ID` header field of the message tracking log entries to return. If the `Message-ID` header field is blank or doesn't exist, an arbitrary value is assigned. This value is constant for the lifetime of the message.
MessageSubject	Optional	System.String	The MessageSubject parameter specifies the `Subject` header field of the messages in the message tracking log entries to return. By default, message subjects are stored in the message tracking logs. To disable logging of message subjects, use the following command: `Set-TransportServer <Identity> -MessageTrackingLogSubjectLoggingEnabled $false`
Recipients	Optional	System.String[]	The Recipients parameter specifies the recipient's SMTP e-mail addresses of the messages in the message tracking log entries to return. Multiple individual recipients included in a single message are logged by using a single message tracking log entry. Unexpanded distribution group recipients are logged by using the distribution group's SMTP e-mail address. Multiple recipient values can be specified by using commas as a delimiter.
Reference	Optional	System.String	The Reference parameter specifies the `Reference` field value of the messages in the message tracking log to return. The `Reference` field contains additional information for specific types of `EventID`: `Send` The `Reference` field contains the `Internet-Message-Id` of any delivery status notification (DSN) messages. `Transfer` The `Reference` field contains the `Internal-Message-Id` of the message being forked. `DSN` The `Reference` field contains the `Internet-Message-Id` of the message that caused the DSN. For all other types of `EventID`, the `Reference` field is blank.
ResultSize	Optional	Microsoft.Exchange.Data.Unlimited	The ResultSize parameter specifies the maximum number of message tracking log entries to display. By default, a maximum of 1,000 entries are displayed. To display all entries, use the value `Unlimited`.
Sender	Optional	System.String	The Sender parameter specifies the sender's SMTP e-mail address for messages in the message tracking log entries to return.
Server	Optional	Microsoft.Exchange.Configuration.Tasks.ServerIdParameter	The Server parameter specifies the Exchange 2010 server that contains the message tracking logs to be searched. The Server parameter can take any of the following values for the target server: Name FQDN Distinguished name (DN) Legacy Exchange DN GUID
Start	Optional	System.DateTime	The Start parameter specifies the start date and time to return message tracking log entries. The date and time must be specified in the format mm/dd/yyyy hh:mm:ss. For example, 05/17/2011 15:15:00 returns results starting from 03:15 pm, May 17, 2011.

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.

Examples

EXAMPLE 1

This example uses the Get-MessageTrackingLog command to retrieve message tracking log entries that were created between March 13, 2010 at 09:00 and March 15, 2010 at 17:00 with a Sender parameter value of john@contoso.com.

	Copy Code
Get-MessageTrackingLog -Start "03/13/2010 09:00:00" -End "03/15/2010 17:00:00" -Sender "john@contoso.com"