EmailAdministrationSettings

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

File Suffix and Directory Location

EmailAdministrationSettings values are stored in the EmailAdminstration.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

EmailAdministrationSettings is available in API version 47.0 and later.

Fields

Field Name	Field Type	Description
enableComplianceBcc	boolean	Indicates whether a copy of each outbound email message is sent to an email address you specify (`true`) or not (`false`). This field has a default value of `false`. To use this feature, you must specify an email address in Compliance BCC Email in Setup. Note
enableEmailConsentManagement	boolean	Indicates whether Enforce Email Privacy Settings is enabled `(true)` or not `(false)`. When enabled, Salesforce respects each recipient’s email privacy preferences. Default value is `false`.
enableEmailSenderIdCompliance	boolean	Indicates whether outgoing emails comply with Sender ID email protocols (`true`) or not (`false`). This field has a default value of `false`. To enable this preference, enableEmailSpfCompliance `must be set to true`. Evaluate the multiple standard email security protocols (SPF, DKIM, and DMARC) supported by Salesforce before you enable this setting. Note
enableEmailSpfCompliance	boolean	Indicates whether outgoing emails comply with Sender Policy Framework (SPF) email authentication (`true`) or not (`false`). This field has a default value of `true`.
enableEmailToSalesforce	boolean	Indicates whether Email to Salesforce is enabled (`true`) or disabled (`false`). This field has a default value of `false`.
enableEmailWorkflowApproval	boolean	Indicates whether users can respond to email approval requests directly from their email (`true`) or not (`false`). This field has a default value of `false`. See Considerations for Email Approval before enabling this field.
enableEnhancedEmailEnabled	boolean	Indicates whether Enhanced Email is enabled `(true)` or not `(false)`. Default value is `true`.
enableHandleBouncedEmails	boolean	Indicates whether emails sent from Salesforce to an invalid email address bounce back to Salesforce (`true`) or not (`false`) . This field has a default value of `true`. With bounce handling enabled, reps know which lead, contact, or person account has a bad email address, and they know which specific email wasn’t delivered.
enableHtmlEmail	boolean	Indicates whether users receive Email-To-Case emails in HTML format (`true`) or receive a text version instead (`false`). This field has a default value of `false`. When this field is set to `true`, users receive a warning message about potential malicious HTML before they view incoming HTML email content.
enableInternationalEmailAddresses	boolean	Indicates whether non-Latin-based characters are allowed in email addresses (`true`) or not (`false`) when sending emails to and from Salesforce. This field has a default value of `true` in orgs created in Summer '20 or later. In orgs created in Spring '20 or earlier, the default value is `false`. Available in API version 49.0 and later. Review the Email Address Internationalization prerequisites and considerations in Salesforce Help before enabling this setting. Note
enableListEmailLogActivities	boolean	Indicates whether Salesforce logs sent list emails as activities `(true)` or not `(false)`. Default value is `true`.
enableResendBouncedEmails	boolean	Indicates whether the system forwards a copy of each bounced email message to the sender (`true`) or only displays the bounce alert (`false`). This field has a default value of `false`. To enable this preference, enableHandleBouncedEmails `must be set to true`.
enableRestrictTlsToDomains	boolean	Indicates whether the selected Transport Layer Security (TLS) setting applies only to specific domains (`true`) or applies to all domains (`false`). This field has a default value of `false`. To enable this preference, you must specify a TLS Setting other than Preferred and provide the comma-separated list of domains through Deliverability in Setup. When this field is set to `true`, any domains not in the list use the system default TLS Setting of Preferred. Note
enableSendThroughGmailPref	boolean	Deprecated.
enableSendViaExchangePref	boolean	Indicates whether users can use Office 365 to send emails `(true)` or not `(false)`. Default value is `false`.
enableSendViaGmailPref	boolean	Indicates whether users can use Gmail to send emails `(true)` or not `(false)`. Default value is `false`.
enableUseOrgFootersForExtTrans	boolean	Indicates whether emails sent through external email services (such as Gmail or Office 365) include the Salesforce footer (`true`) or not (`false`). This field has a default value of `false`.
sendMassEmailNotification	boolean	Indicates whether users receive an auto-generated status email from Salesforce for each mass email they send (`true`) or not (`false`). This field has a default value of `true`.
sendTextOnlySystemEmails	boolean	Indicates whether all system emails are sent via text only (`true`) or allow other formats (`false`). This field has a default value of `false`.

Declarative Metadata Sample Definition

The following is an example of an EmailAdministrationSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2                <EmailAdministrationSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3                <enableEmailWorkflowApproval>false</enableEmailWorkflowApproval>
4                <enableComplianceBcc>false</enableComplianceBcc>
5                <enableEmailSenderIdCompliance>false</enableEmailSenderIdCompliance>
6                <enableEmailSpfCompliance>true</enableEmailSpfCompliance>
7                <enableEmailToSalesforce>false</enableEmailToSalesforce>
8                <enableHandleBouncedEmails>true</enableHandleBouncedEmails>
9                <enableHtmlEmail>true</enableHtmlEmail>
10                <enableInternationalEmailAddresses>true</enableInternationalEmailAddresses>
11                <enableResendBouncedEmails>false</enableResendBouncedEmails>
12                <enableRestrictTlsToDomains>false</enableRestrictTlsToDomains>
13                <sendMassEmailNotification>true</sendMassEmailNotification>
14                <sendTextOnlySystemEmails>false</sendTextOnlySystemEmails>
15                <enableUseOrgFootersForExtTrans>false</enableUseOrgFootersForExtTrans>
16                <enableSendViaGmailPref>false</enableSendViaGmailPref>
17                <enableSendViaExchangePref>true</enableSendViaExchangePref>
18                <enableListEmailLogActivities>false</enableListEmailLogActivities>
19                <enableEnhancedEmailEnabled>false</enableEnhancedEmailEnabled>
20                <enableEmailConsentManagement>false</enableEmailConsentManagement>
21                </EmailAdministrationSettings>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2                <Package xmlns="http://soap.sforce.com/2006/04/metadata">
3                <types>
4                <members>EmailAdministration</members>
5                <name>Settings</name>
6                </types>   
7                <version>49.0</version>
8                </Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide

File Suffix and Directory Location

Version

Fields

Declarative Metadata Sample Definition

Wildcard Support in the Manifest File

See Also