Skip to content

Latest commit

 

History

History
224 lines (124 loc) · 4.74 KB

directmarketing-emailaddress.schema.md

File metadata and controls

224 lines (124 loc) · 4.74 KB

Direct Marketing Email Address Schema

https://ns.adobe.com/xdm/context/directmarketing-emailaddress

Direct marketing email address.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted context/directmarketing-emailaddress.schema.json

Schema Hierarchy

  • Direct Marketing Email Address https://ns.adobe.com/xdm/context/directmarketing-emailaddress

Direct Marketing Email Address Example

{
  "xdm:primary": false,
  "xdm:address": "jsmith@xyzinc.com",
  "xdm:label": "John Smith",
  "xdm:type": "work",
  "xdm:status": "active",
  "xdm:errorCount": 0
}

Direct Marketing Email Address Properties

Property Type Required Default Defined by
xdm:address string Optional Email Address
xdm:errorCount integer Optional Direct Marketing Email Address (this schema)
xdm:label string Optional Email Address
xdm:primary boolean Optional Email Address
xdm:quality string Optional Direct Marketing Email Address (this schema)
xdm:status string Optional "active" Email Address
xdm:statusReason string Optional Email Address
xdm:type string Optional Email Address
* any Additional this schema allows additional properties

xdm:address

Address

The technical address, e.g 'name@domain.com' as commonly defined in RFC2822 and subsequent standards.

xdm:address

xdm:address Type

string

xdm:errorCount

Error Count

Number of consecutive errors when sending to this email address.

xdm:errorCount

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

xdm:errorCount Type

integer

xdm:label

Label

Additional display information that maybe available, e.g MS Outlook rich address controls display 'John Smith smithjr@company.uk', the 'John Smith' part is data that would be placed in the label.

xdm:label

xdm:label Type

string

xdm:primary

Primary

Primary email indicator.

A Profile can have only one primary email address at a given point of time.

xdm:primary

xdm:primary Type

boolean

xdm:quality

Quality

Quality rating.

xdm:quality

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

xdm:quality Type

string

xdm:status

Status

An indication as to the ability to use the email address.

xdm:status

  • is optional
  • type: string
  • default: "active"
  • defined in Email Address

xdm:status Type

string

xdm:status Known Values

Value Description
active Active
incomplete Incomplete
pending_verification Pending Verification
blacklisted Blacklisted
blocked Blocked

xdm:statusReason

Status Reason

A description of the current status.

xdm:statusReason

xdm:statusReason Type

string

xdm:type

Type

The way the account relates to the person. e.g 'work' or 'personal'

xdm:type

xdm:type Type

string

xdm:type Known Values

Value Description
unknown Unknown
personal Personal
work Work
education Education