Edit

Share via


exchangeMessageTrace resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents the trace information for an email message as it passes through the Exchange Online organization. Message trace enables tenant administrators to track the lifecycle of an email, determine its delivery status—whether delivered, pending, failed, or quarantined—and understand the actions applied to it.

Methods

Method Return type Description
List message traces exchangeMessageTrace collection Get a list of exchangeMessageTrace objects.
Get details by recipient exchangeMessageTraceDetail collection Get a list of exchangeMessageTraceDetail objects filtered on the recipient.

Properties

Property Type Description
fromIP String The source IP address. For incoming messages, this value is the public IP address of the SMTP email server that sent the message.
id String The unique identifier for the message trace.
messageId String The Message-ID header field of the message. The format of the Message-ID depends on the messaging server that sent the message.
receivedDateTime DateTimeOffset The date and time when the message was received by Exchange Online. The timestamp is in UTC format.
recipientAddress String The SMTP email address of the user that the message was addressed to.
senderAddress String The SMTP email address of the user the message was purportedly from.
size Int32 The size of the message in bytes.
status exchangeMessageTraceStatus The delivery status of the message. The possible values are: gettingStatus, pending, failed, delivered, expanded, quarantined, filteredAsSpam, unknownFutureValue.
subject String The subject line of the message.
toIP String The destination IP address. For outgoing messages, this value is the public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, this value is blank.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.exchangeMessageTrace",
  "fromIP": "String",
  "id": "String (identifier)",
  "messageId": "String",
  "receivedDateTime": "String (timestamp)",
  "recipientAddress": "String",
  "senderAddress": "String",
  "size": "Int32",
  "status": "String",
  "subject": "String",
  "toIP": "String"
}