Skip to main content

Apple Business guidance for capturing an email address

Address​

address identifies the email address (in part or in whole) that will be used by an organization to originate an email and send to a customer's device. The associated brand's display name and brand asset (logo) are candidates for display in Apple Mail.

Template to Explain Data Requirements
{local part}@{subdomain}.{domain}.{top level domain}

Address Requirements​

  • address MUST include domain and top level domain (e.g., brand.com)
  • address MUST NOT match an existing address associated with the same or a different brand ID
  • Multiple address resources MAY have the same domain provided that a combination of subdomain and/or local-part makes each of them distinct
  • address MAY include subdomain (e.g., news.brand.com)
  • address MAY include local part (e.g., user@brand.com or user@news.brand.com)
  • address MUST NOT begin with @ (at-sign character)
ParentNameTypeInputDescription
emailIdDetailsaddressstring
REQUIRED
Email address or domain pattern used to identify sender

Address Examples​

brand.com

Security and Verification​

Email ID resources require domain ownership verification and DMARC verification before they can be published:

  1. Domain Verification: Partners must prove ownership of the domain by adding a DNS TXT record
  2. DMARC Verification: The domain must have a valid DMARC record configured for email authentication
Important Restrictions
  • Email ID resources cannot be updated after publication.
  • If an address has a subdomain and a "main" domain part already exists under the same brand, the subdomain resource is unnecessary.
  • Each brand is limited to a maximum number of Email ID resources.
NameDescription
Email IDEmail ID API