Email

An email address. Alias for the email type.

Formats

Example

A JSON example of this model.

"john.doe@example.com"

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: email.yaml
type: string
examples:
  - test@example.com
format: email
description: An email address

TypeSpec

The TypeSpec code for this model.

/** An email address. */
alias Email = Types.email; // Exposes Email from CommonGrants.Fields

EmailCollection

A collection of email addresses for a person or organization.

Table

Property	Type	Required	Description
primary	email	Yes	The primary email address for a person or organization.
otherEmails	record<email>	No	Additional email addresses keyed by a descriptive label (e.g., "work", "personal", "support").

Formats

Example

A JSON example of this model.

{
  "primary": "test@example.com",
  "otherEmails": {
    "property": "test@example.com"
  }
}

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: EmailCollection.yaml
type: object
properties:
  primary:
    $ref: email.yaml
    description: The primary email address for a person or organization.
  otherEmails:
    $ref: "#/$defs/RecordEmail"
    description: Additional email addresses keyed by a descriptive label (e.g., "work", "personal", "support").
required:
  - primary
unevaluatedProperties:
  not: {}
examples:
  - primary: john.doe@example.com
    otherEmails:
      work: john.doe@work.com
      personal: john.doe@gmail.com
      school: john.doe@school.edu
description: A collection of email addresses.
$defs:
  RecordEmail:
    type: object
    properties: {}
    unevaluatedProperties:
      $ref: email.yaml

TypeSpec

The TypeSpec code for this model.

/** A collection of email addresses. */
@example(Examples.Email.personalCollection)
@Versioning.added(CommonGrants.Versions.v0_2)
model EmailCollection {
  /** The primary email address for a person or organization. */
  primary: Types.email;

  /** Additional email addresses keyed by a descriptive label (e.g., "work", "personal", "support"). */
  otherEmails?: Record<Types.email>;
}

Changelog

Version	Changes
0.2.0	Added EmailCollection model