Skip to content

email-interaction.schema.md

Latest commit

 

History

History
454 lines (239 loc) · 9.01 KB

email-interaction.schema.md

File metadata and controls

454 lines (239 loc) · 9.01 KB

Email Interaction Schema

https://ns.adobe.com/xdm/common/emailinteraction

Captures information in the context of an email correspondence between persons

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted datatypes/email-interaction.schema.json

Schema Hierarchy

  • Email Interaction https://ns.adobe.com/xdm/common/emailinteraction

Email Interaction Example

{
  "xdm:priority": "high",
  "xdm:sentDateTime": "2020-05-18T00:00:00+00:00",
  "xdm:receivedDateTime": "2020-05-18T00:00:28+00:00",
  "xdm:body": "Mark nice to meet you virtually and welcome back to conversations with Marketo......",
  "xdm:hasAttachments": false,
  "xdm:isQuarantined": false,
  "xdm:sizeInBytes": 2576,
  "xdm:failureReasonCode": "0-0000",
  "xdm:failureReasonMessage": "Success",
  "xdm:fromAddress": "abc@google.com",
  "xdm:toAddress": [
    "mark@google.com"
  ],
  "xdm:ccAddress": [
    "p@google.com",
    "q@yahoo.com"
  ],
  "xdm:bccAddress": [
    "r@google.com"
  ],
  "xdm:headers": "Return-Path: <abc@google.com> X-SpamCatcher-Score: 1 [X] Received: from [136.167.40.119]",
  "xdm:incomingMessage": false,
  "xdm:firstOpenDate": "2020-05-18T05:00:00+00:00",
  "xdm:lastOpenDate": "2020-05-20T00:12:28+00:00",
  "xdm:isTracked": true
}

Email Interaction Properties

Property Type Required Defined by
xdm:bccAddress string[] Optional Email Interaction (this schema)
xdm:body string Optional Email Interaction (this schema)
xdm:ccAddress string[] Optional Email Interaction (this schema)
xdm:failureReasonCode string Optional Email Interaction (this schema)
xdm:failureReasonMessage string Optional Email Interaction (this schema)
xdm:firstOpenDate string Optional Email Interaction (this schema)
xdm:fromAddress string Optional Email Interaction (this schema)
xdm:hasAttachments boolean Optional Email Interaction (this schema)
xdm:headers string Optional Email Interaction (this schema)
xdm:incomingMessage boolean Optional Email Interaction (this schema)
xdm:isQuarantined boolean Optional Email Interaction (this schema)
xdm:isTracked boolean Optional Email Interaction (this schema)
xdm:lastOpenDate string Optional Email Interaction (this schema)
xdm:priority string Optional Email Interaction (this schema)
xdm:receivedDateTime string Optional Email Interaction (this schema)
xdm:sentDateTime string Optional Email Interaction (this schema)
xdm:sizeInBytes number Optional Email Interaction (this schema)
xdm:toAddress string[] Optional Email Interaction (this schema)
* any Additional this schema allows additional properties

xdm:bccAddress

An array of email addresses for the bcc list

Person or list of people who are in the bcc list of the email message

xdm:bccAddress

  • is optional

  • type: string[]

  • defined in this schema

xdm:bccAddress Type

Array type: string[]

All items must be of the type: string

xdm:body

Body of the mail

The contents of the email after substitution of the placeholders in the template

xdm:body

  • is optional
  • type: string
  • defined in this schema

xdm:body Type

string

xdm:ccAddress

An array of email addresses for the cc list

Person or list of people who are in the cc list of the email message

xdm:ccAddress

  • is optional

  • type: string[]

  • defined in this schema

xdm:ccAddress Type

Array type: string[]

All items must be of the type: string

xdm:failureReasonCode

Reason code for failure

Indicates the error code for not able to deliver the email message

xdm:failureReasonCode

  • is optional
  • type: string
  • defined in this schema

xdm:failureReasonCode Type

string

xdm:failureReasonMessage

Reason Message for failure

Indicates the full message for the error code, for not able to deliver the message

xdm:failureReasonMessage

  • is optional
  • type: string
  • defined in this schema

xdm:failureReasonMessage Type

string

xdm:firstOpenDate

First time the email was opened by the receiver

First date and time when the receiver took the action to open the email

xdm:firstOpenDate

  • is optional
  • type: string
  • defined in this schema

xdm:firstOpenDate Type

string

xdm:fromAddress

Person sending the email communication

Person who is sender of the email message

xdm:fromAddress

  • is optional
  • type: string
  • defined in this schema

xdm:fromAddress Type

string

xdm:hasAttachments

Email has attachments

A flag represent whether any attachment is part of the email message

xdm:hasAttachments

  • is optional
  • type: boolean
  • defined in this schema

xdm:hasAttachments Type

boolean

xdm:headers

Email headers

Captures the headers of the email for diagnosis

xdm:headers

  • is optional
  • type: string
  • defined in this schema

xdm:headers Type

string

xdm:incomingMessage

Inbound or Outbound Message

A flag to represent whether a message was sent or recieved

xdm:incomingMessage

  • is optional
  • type: boolean
  • defined in this schema

xdm:incomingMessage Type

boolean

xdm:isQuarantined

quarantine message

A flag to represent whether the email message is a spam

xdm:isQuarantined

  • is optional
  • type: boolean
  • defined in this schema

xdm:isQuarantined Type

boolean

xdm:isTracked

Email Tracking flag

A flag to capture whether the email was tracked by the sender

xdm:isTracked

  • is optional
  • type: boolean
  • defined in this schema

xdm:isTracked Type

boolean

xdm:lastOpenDate

Last time when the email was opened by the receiver

Last time the email was opened, by any receiver

xdm:lastOpenDate

  • is optional
  • type: string
  • defined in this schema

xdm:lastOpenDate Type

string

xdm:priority

Email's priority

Captures the priority set by the person who sent the email

xdm:priority

  • is optional
  • type: string
  • defined in this schema

xdm:priority Type

string

xdm:receivedDateTime

Date and time the email was received

Captures the date and time when the email was received

xdm:receivedDateTime

  • is optional
  • type: string
  • defined in this schema

xdm:receivedDateTime Type

string

xdm:sentDateTime

Date and time the email was sent

Captures the date and time the email correspondence was sent to an individual or a group of people

xdm:sentDateTime

  • is optional
  • type: string
  • defined in this schema

xdm:sentDateTime Type

string

xdm:sizeInBytes

Email message size

Record the size of the email message in bytes

xdm:sizeInBytes

  • is optional
  • type: number
  • defined in this schema

xdm:sizeInBytes Type

number

xdm:toAddress

An array of email addresses for the To list

Person or list of people who are in the To list of the email message

xdm:toAddress

  • is optional

  • type: string[]

  • defined in this schema

xdm:toAddress Type

Array type: string[]

All items must be of the type: string