Skip to main content

Email ID feature validation rules for limits, DMARC verification, and DNS TXT record requirements

Email ID Feature

CountOfEmailIdsMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that the count of Email ID features does not exceed threshold
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__CountOfEmailIdsMustNotExceedMaximum",
"severity": "VIOLATION",
"message": "Count of EmailIds must not exceed maximum"
}

EmailIdIsBlocked

DefinitionSeverityAPISampleMode
Validate that the Email ID feature has been enabled for the organization's brand
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__EmailIdIsBlocked",
"severity": "VIOLATION",
"message": "Email ID feature is blocked for the brand as per Apple Business policy"
}

DMARC

EmailIdDMARCAlreadyVerified

DefinitionSeverityAPISampleMode
Validate that a DMARC record is not already verified
VIOLATION
PUT
S
Example Validation Report
{
"code": "VALIDATION__EmailIdDMARCAlreadyVerified",
"severity": "VIOLATION",
"message": "DMARC record has already been verified for email ID resource '{{id}}'",
"context": {
"id": "9467895078742654451"
}
}

EmailIdDMARCVerificationFailed

DefinitionSeverityAPISampleMode
Validate that email ID DMARC verification is successful
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__EmailIdDMARCVerificationFailed",
"severity": "VIOLATION",
"message": "DMARC record verification for email ID resource '{{id}}' failed",
"context": {
"id": "9467895078742654451"
}
}

EmailIdDMARCVerificationRequired

DefinitionSeverityAPISampleMode
Validate that email ID DMARC verification is completed
VIOLATION
POST_AND_PUT
S

DNS TXT Record

EmailIdAlreadyVerified

Preconditions
Attempted to create a DNS text value or verify domain
DefinitionSeverityAPISampleMode
Validate that an email ID is not verified
VIOLATION
PUT
S
Example Validation Report
{
"code": "VALIDATION__EmailIdAlreadyVerified",
"severity": "VIOLATION",
"message": "Email ID for resource '{{id}}' has already been verified",
"context": {
"id": "9467895078742654451"
}
}

EmailIdDomainTxtVerificationRequired

DefinitionSeverityAPISampleMode
Validate that email ID domain verification is completed
VIOLATION
POST_AND_PUT
S

EmailIdDomainVerificationFailed

DefinitionSeverityAPISampleMode
Validate that an email ID domain verification is successful
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__EmailIdDomainVerificationFailed",
"severity": "VIOLATION",
"message": "Email ID resource '{{id}}' domain verification failed",
"context": {
"id": "9467895078742654451"
}
}

EmailIdHasNoDNSTextOrTimePeriodToVerifyHasExpired

Preconditions
Attempted to verify domain
DefinitionSeverityAPISampleMode
Validate that a DNS text value has already been provided and the elapsed time between DNS text value creation and a request to verify a domain has not exceeded threshold
VIOLATION
PUT
S
Example Validation Report
{
"code": "VALIDATION__EmailIdHasNoDNSTextOrTimePeriodToVerifyHasExpired",
"severity": "VIOLATION",
"message": "Email ID resource '{{id}}' has no DNS TXT record or time to verify has expired",
"context": {
"id": "9467895078742654451"
}
}