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
addressMUST include domain and top level domain (e.g.,brand.com)addressMUST NOT match an existingaddressassociated with the same or a different brand ID- Multiple
addressresources MAY have the same domain provided that a combination of subdomain and/or local-part makes each of them distinct addressMAY include subdomain (e.g.,news.brand.com)addressMAY include local part (e.g.,user@brand.comoruser@news.brand.com)addressMUST NOT begin with@(at-sign character)
| Parent | Name | Type | Input | Description |
|---|---|---|---|---|
emailIdDetails | address | string | 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:
- Domain Verification: Partners must prove ownership of the domain by adding a DNS TXT record
- 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.
Related
| Name | Description |
|---|---|
| Email ID | Email ID API |