CIPP.app icon

CIPP.app

Manage Microsoft 365 tenants via CIPP.app

Actions619

Mailbox → List Message Trace

AI-generated

Summary

List message trace records for a specified tenant with optional detailed filters, returning a list of message trace objects.

Inputs

  • tenantFilter (required) — The tenant to perform the operation on, selected either from a list or specified by domain.
  • returnAll — Toggle to return all matching results instead of limiting the output.
  • limit — Maximum number of message trace results to return if 'Return All' is false; up to 500.
  • messageTraceFilters — Optional collection of filters to narrow message trace results, including date filters (relative days or explicit start/end), sender, recipient, message ID, status, IP addresses, and trace detail.

Output shape

a list of message trace objects

Results respect the 'returnAll' and 'limit' input parameters. Filtering fields in 'messageTraceFilters' are applied to refine the trace records returned. The operation requires specifying the tenant context. Returned data includes message trace details as provided by the API.

Examples

Example 1: Retrieve the 50 most recent message trace records for a tenant selected from the list with a relative date filter of 7 days.

Set tenantFilter mode to 'list' with the selected tenant, leave 'returnAll' false, 'limit' 50, and set 'days' under messageTraceFilters to 7.

Example 2: Fetch all message trace records for a tenant filtered by specific sender and recipient email addresses within a custom start and end date.

Set tenantFilter to target tenant, enable 'returnAll', set messageTraceFilters with 'sender', 'recipient' emails comma-separated, 'dateFilter' to 'startEnd' with 'startDate' and 'endDate' specified.

Links

Discussion