Skip to content

emailaddress.schema.md

Latest commit

 

History

History
178 lines (102 loc) · 3.68 KB

emailaddress.schema.md

File metadata and controls

178 lines (102 loc) · 3.68 KB

Email address Schema

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

A standard email address.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted datatypes/emailaddress.schema.json

Schema Hierarchy

  • Email address https://ns.adobe.com/xdm/context/emailaddress

Email address Example

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

Email address Properties

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

xdm:address

Address

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

xdm:address

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

xdm:address Type

string

xdm:label

Label

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

xdm:label

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

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

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

xdm:primary Type

boolean

xdm:status

Status

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

xdm:status

  • is optional
  • type: string
  • default: "active"
  • defined in this schema

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

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

xdm:statusReason Type

string

xdm:type

Type

The way the account relates to the person for example 'work' or 'personal'.

xdm:type

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

xdm:type Type

string

xdm:type Known Values

Value Description
unknown Unknown
personal Personal
work Work
education Education