emailaddress.schema.json

{
  "meta:license": [
    "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$id": "https://ns.adobe.com/xdm/context/emailaddress",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Email Address",
  "type": "object",
  "meta:extensible": true,
  "description": "A standard email address.",
  "definitions": {
    "emailaddress": {
      "properties": {
        "xdm:primary": {
          "title": "Primary",
          "type": "boolean",
          "description":
            "Primary email indicator.\n\nA Profile can have only one `primary` email address at a given point of time.\n"
        },
        "xdm:address": {
          "title": "Address",
          "type": "string",
          "format": "email",
          "description":
            "The technical address, e.g 'name@domain.com' as commonly defined in RFC2822 and subsequent standards."
        },
        "xdm:label": {
          "title": "Label",
          "type": "string",
          "description":
            "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:type": {
          "title": "Type",
          "type": "string",
          "description":
            "The way the account relates to the person. e.g 'work' or 'personal'",
          "meta:enum": {
            "unknown": "Unknown",
            "personal": "Personal",
            "work": "Work",
            "education": "Education"
          }
        },
        "xdm:status": {
          "title": "Status",
          "type": "string",
          "description":
            "An indication as to the ability to use the email address.",
          "default": "active",
          "meta:enum": {
            "active": "Active",
            "incomplete": "Incomplete",
            "pending_verification": "Pending Verification",
            "blacklisted": "Blacklisted",
            "blocked": "Blocked"
          }
        },
        "xdm:statusReason": {
          "title": "Status Reason",
          "type": "string",
          "description": "A description of the current status."
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "#/definitions/emailaddress"
    }
  ],
  "meta:status": "stabilizing"
}