Get-CIPPMessageTrace.md

Get-CIPPMessageTrace

SYNOPSIS

Retrieves the message trace for a specific customer tenant ID.

DESCRIPTION

The Get-CIPPMessageTrace function retrieves the message trace for a specific customer tenant ID within a specified number of days. It can also filter the results based on the sender and recipient email addresses.

PARAMETERS

-CustomerTenantID

Specifies the customer tenant ID for which the message trace needs to be retrieved. This parameter is mandatory.

-Days

Specifies the number of days within which the message trace needs to be retrieved. This parameter is mandatory.

-Sender

Specifies the sender email address to filter the message trace results. This parameter is optional.

-Recipient

Specifies the recipient email address to filter the message trace results. This parameter is optional.

EXAMPLE 1

PS > Get-CIPPMessageTrace -CustomerTenantID "contoso.onmicrosoft.com" -Days 7

EXAMPLE 2

PS > Get-CIPPMessageTrace -CustomerTenantID "contoso.onmicrosoft.com" -Days 30 -Sender "[email protected]"

EXAMPLE 3

PS > Get-CIPPMessageTrace -CustomerTenantID "contoso.onmicrosoft.com" -Days 14 -Recipient "[email protected]"