AuthorizedEmailDomain

Represents an authorized domain for email verification.

Introduced in API version 64.0.

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

DELETE, GET, HEAD, PATCH, POST, Query

• To create or modify authorized email domains, users must have the Email Administration permission.

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API.

Note these important considerations.

• When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.
• Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

• Type: string

• Required: No

• Properties: Create, Filter, Group, idLookup, Sort

• Description: The unique domain name.

• Type: boolean

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Sort, Update

• Description: Indicates whether Salesforce successfully verified ownership of this domain (true) or not (false).

The default value is false.

• Default value: false

• Type: boolean

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Sort, Update

• Introduced: API version 68.0

• Description: Indicates whether email address verification is required for updated user email addresses, user return email addresses, and organization-wide email addresses on this domain (true) or not (false).

The default value is true.

When IsDomainOwnershipVerified is false, then IsEmailChangeVerfRqr has no effect.

• Default value: false

• Type: boolean

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Sort, Update

• Description: Indicates whether address verification is required before Salesforce can send email for new users and new organization-wide email addresses with email addresses on this domain (true) or not (false).

The default value is true.

When IsDomainOwnershipVerified is false, IsEmailVerificationRequired has no effect.

When IsDomainOwnershipVerified is true, IsEmailVerificationRequired and IsEmailChangeVerfRqr determine when address verification is required for updated user email addresses, user return email addresses, and organization-wide email addresses on this domain.

• If IsEmailVerificationRequired and IsEmailChangeVerfRqr are true, then email address verification is always required before Salesforce can send email for users and organization-wide email addresses with email addresses on this domain.

• If IsEmailVerificationRequired is true and IsEmailChangeVerfRqr is false, then address verification isn’t required for new user email addresses, new user return email addresses, and new organization-wide email addresses on this domain. However, address verification is required when an existing user email address, user return email address, or organization-wide email address is updated to an address on this domain.

• If IsEmailVerificationRequired and IsEmailChangeVerfRqr are false, then address verification is never required for user email addresses, user return email addresses, and organization-wide email addresses on this domain.

• Default value: false

• Type: boolean

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Sort, Update

• Introduced: API version 67.0

• Default value: false

• Type: picklist

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: Specifies the language of the authorized email domain. The value for this field is the language value of the org.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: Master label for this object. This display value is the internal label that is not translated.

Domain verification is required to bypass email verification for an authorized email domain.

To verify ownership of an authorized email domain, first create an AuthorizedEmailDomain with IsDomainOwnershipVerified set to false.

Then determine the verification code for the authorized email domain. Use the format orgId=AuthorizedEmailDomainId where orgId is the 15-digit ID for your Salesforce org and AuthorizedEmailDomainId is the authorized email domain Id. You can also find the verification code on the Authorized Email Domains page in Setup.

Add a DNS TXT record for the DomainName with or without _sfdv. as a prefix that points to a verification code.

Here’s an example of a DNS TXT record for an authorized email domain with a DomainName of example.com and an AuthorizedEmailDomainId of 1TB00000000000B in an org with ID 00D000000000P08.

1Name                TTL  CLASS  TYPE     VALUE
2-------------------------------------------------------------------- 
3example.com.        600  IN     TXT      "00D000000000P08=1TB00000000000B”

Here’s an example of a DNS TXT record for the same domain with the _sfdv. prefix.

1Name                TTL  CLASS  TYPE     VALUE
2-------------------------------------------------------------------- 
3_sfdv.example.com.  600  IN     TXT      "00D000000000P08=1TB00000000000B”

If a DNS TXT record already exists for DomainName and _sfdv.DomainName, you can create a second TXT record for one of those names or you can append the verification code to the value list of an existing TXT record. To append a value, separate the values with a semicolon (;).

To start the domain verification process after the required DNS TXT record exists, set IsDomainOwnershipVerified to true. If that verification process succeeds, IsDomainOwnershipVerified remains true. Otherwise, an error is returned and IsDomainOwnershipVerified is set to false.

For more information and examples, see Set Up an Authorized Email Domain in Salesforce Help.