EDRs

Introduction

Email messages sent may have EDRs created for them, if an EDR sink is configured and enabled for the JSLEE email service.

In addition to the common fields written for all EDRs, EDRs generated by the email service have several additional fields.

Email service EDRs have a type of email-message.

Root Additional Fields

The email service may write the following additional fields to EDRs:

Field Type Presence Description
email-message-info Object Always Holds information about the email in the fields described in Email Information Field.
delivery-info Object Always Holds information about the short message delivery in the fields described in Delivery Information Field.

Other Additional Fields

Email Information Field

The email information field (key email-message-info) holds information about the short message that caused the EDR to be created. It may contain the following fields:

Field Type Presence Description
email-from-address String Always The email From: address (and potentially name).
email-to-address String Always The email To: address (and potentially name).
message-text String Always Holds the text of the email.
email-message-subject String Always Holds the subject line of the email.
email-message-id String Always The generated message ID for the email. This corresponds to the value of the SMTP header Message-ID.
email-message-priority Integer Conditional Indicates the priority of the email. This corresponds to the value of the SMTP header X-Priority, if it was included.
status-report-requested Boolean Always Indicates whether a delivery report was requested for the message. This corresponds to whether the SMTP header Return-Receipt-To was included.

Delivery Information Field

This field holds information about the email delivery. It may contain the following fields:

Field Type Presence Description
delivery-status String Always Indicates the success or failure of the communication with the network about the message. Possible values are:
  • SUCCESS: The message was delivered successfully.
  • TRANSIENT_FAILURE: The message was not delivered due to a transient failure.
  • PERMANENT_FAILURE: The message was not delivered due to a permanent failure.
  • QUEUED: The message was queued for later delivery.