EmailDomainKey

Supported Calls

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

Special Access Rules

We’ve upgraded and replaced the original DKIM (DomainKeys Identified Mail) key feature, so that you can create a DKIM key with increased email security. For more information, see Setting Up More Secure DKIM Keys.

Fields

Field Name	Details
AlternatePublicKey	Type textarea Properties Nillable Description Read-only. Alternate public keys are used by Salesforce to auto-rotate domain keys. This field is available in API version 44.0 and later after activating the Critical Update.
AlternateSelector	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The text used to distinguish the DKIM key from any other DKIM keys your organization uses for the specified domain. This field is available in API version 44.0 and later after activating the Critical Update.
AlternateTxtRecordName	Type string Properties Filter, Group, Nillable, Sort Description The alternate TXT record name is used to create the CNAME record. Refer to the Usage section for more information. This field is available in API version 44.0 and later after activating the Critical Update.
Domain	Type string Properties Create, Filter, Group, Sort, Update Description The organization’s domain name that the DKIM key is generated for.
DomainMatch	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The specificity of match required on the sending domain name before signing with this DKIM key. Valid values are: `DomainOnly`—Sign if sending domain matches at the domain level only (example.com but not mail.example.com) `SubdomainsOnly`—Sign if sending domain matches at the subdomain level only (mail.example.com but not example.com) `DomainAndSubdomains`—Sign if sending domain matches at the domain and subdomain levels (example.com and mail.example.com)
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this DKIM key is active (`true`) or not (`false`).
KeySize	Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description Indicates the RSA key size, in bits. The possible values are: 1024 2048 This field is available in API version 45.0 and later.
PrivateKey	Type textarea Properties Create, Nillable, Update Description Once you activate the Critical Update, this field is no longer visible. The private portion of the DKIM key pair used to encrypt mail headers from your domain. Salesforce generates an encrypted PrivateKey if you don’t specify a value when creating the DKIM key. If you do specify a value, it must be an existing valid PrivateKey from another EmailDomainKey object. This field doesn’t contain the actual private key, but a value that represents the key in our system. Therefore: The actual private key can’t be leaked. You can’t use the value to do your own email signing.
PublicKey	Type textarea Properties Create, Nillable, Update Description Part of the domain key pair that mail recipients retrieve to decrypt the DKIM header and verify your domain. Add the PublicKey value to your domain’s DNS records before you start signing with this domain key.
Selector	Type string Properties Create, Filter, Group, Sort, Update Description Text used to distinguish the DKIM key from any other DKIM keys your organization uses for the specified domain.
TxtRecordName	Type string Properties Filter, Group, Nillable, Sort Description Read-only. The TXT record name is used to create the CNAME record. Refer to the Usage section for more information. This field is available in API version 44.0 and later after activating the Critical Update.
TxtRecordsPublishState	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The possible values are: Published Publishing in progress Publishing failed This field is available in API version 44.0 and later after activating the Critical Update.

Usage

Create DKIM Keys with Increased Security

If your Salesforce org was created before Winter ’19, enable the Critical Update. From Setup, enter Critical Updates in the Quick Find box, and then select Critical Updates. For Enable Redesigned DomainKeys Identified Mail (DKIM) Key Feature with Increased Email Security, click Activate.
Insert Domain, DomainMatch, Selector, and AlternateSelector. Salesforce publishes your TXT record to DNS.
Retrieve the TxtRecordName and AlternateTxtRecordName and use them to create and publish the CNAME and Alternate CNAME record to your domain’s DNS.
1. Create CNAME record using: <selector>._domainkey.<domain> IN CNAME txtRecordName.
2. Create Alternate CNAME record using: <alternateSelector>._domainkey.<domain> IN CNAME alternateTxtRecordName.
Set the IsActive field to true.

Create DKIM Keys (pre-Winter ‘19 Version)

The critical update activates for everyone on October 15, 2019. After that date, this approach to creating DKIM keys will no longer be available.

Note

When you create a DKIM key, Salesforce generates a public and private key pair. Publish the public key in the DNS.

For each domain key you create, we recommend this sequence:

Insert the Domain, DomainMatch, and Selector.
Update your domain’s DNS records.
1. Locate the DNS record at selector._domainkey.domain. For example, mail._domainkey.mail.example.com.
2. Add the PublicKey value, like this: V=DKIM1; p=public_key.
DKIM Signing Outbound Email
1. In addition, you can optionally put the record in testing mode, which instructs recipients to not make decisions based on the email signature. Add parameter t=y to the DNS entry: V=DKIM1; t=y; p=public_key.
Update the key via the API or UI to be active.

Object Reference for Salesforce and Lightning Platform

Supported Calls

Special Access Rules

Fields

Usage

See Also