EmailIntegrationSettings | Metadata API Developer Guide

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

File Suffix and Directory Location

EmailIntegrationSettings values are stored in the EmailIntegration.settings file in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

EmailIntegrationSettings fields are available in API version 47.0 and later.

Fields

Field Name	Field Type	Description
doesEmailLogAsEmailMessageInOutlook	boolean	Indicates whether the Outlook integration logs emails to the Email Message object (`true`) or as tasks (`false`). The default value is `true`. This field can only be used if the enableOutlookIntegration field is set to `true`.
doesGmailStayConnectedToSalesforce	boolean	Indicates whether Gmail integration users log in to Salesforce from Gmail each time their sessions expires. If set to `true`, users log in from the Gmail integration once, and their credentials are remembered the next time they use the Gmail integration. If set to `false`, users log in to Salesforce from the Gmail integration each time their Salesforce session expires. The default value is `false`. This field can only be used if the enableGmailIntegration field is set to `true`.
enableEmailTrackingInMobile	boolean	Indicates whether Salesforce Inbox mobile users can track emails (`true`) or not (`false`) while in the Inbox mobile app. The default value is `true`. This setting applies only to email tracking in the Salesforce Inbox mobile app. To disable the feature in Outlook or Gmail, use the Lightning App Builder. Remove the Email Tracking - Compose and Email Tracking - List components from the email application pane after setting the isLayoutCustomizationAllowed field to `true`.
enableEngageForOutlook	boolean	Indicates whether Engage For Outlook is enabled (`true`) or not (`false`). When set to `true`, Engage users can connect their Outlook account and send Engage emails from their Outlook inbox.
enableGmailIntegration	boolean	Indicates whether the Gmail integration is enabled (`true`) or not (`false`). When set to `true`, G Suite users with the Gmail integration can connect their Gmail account and work with Salesforce data in their email. The default value is `true`.
enableOutlookIntegration	boolean	Indicates whether the Outlook integration is enabled (`true`) or not (`false`). When set to `true`, Outlook users with the Outlook integration can connect their Outlook account and work with Salesforce data in their email. The default value is `false`.
enableProductivityFeatures	boolean	Indicates whether Inbox features, such as Availability and Send later, are available (`true`) or not available (`false`) in the Outlook or Gmail integration. The default value is `false`. This field can only be used if either the enableOutlookIntegration or enableGmailIntegration field is set to `true` and if the org has an Inbox license. To see Inbox features, users must also have either the Inbox with Einstein Activity Capture or the Inbox without Einstein Activity capture permission set. Note
enableSupplementalContactInfoInMobile	boolean	Indicates whether Salesforce Inbox mobile app users see third-party contact information when contacts are shown (`true`) or not (`false`) in the Inbox mobile app. The default value is `false`.
isLayoutCustomizationAllowed	boolean	Indicates whether Salesforce admins are allowed (`true`) or not allowed (`false`) to create custom email application panes using the Lightning App Builder. The email application pane defines the layout of the Salesforce pane in Outlook and Gmail. The default value is `true`. This field can only be used if either the enableOutlookIntegration or enableGmailIntegration field is set to `true`.
shouldUseTrustedDomainsList	boolean	Indicates if the web domains listed in the Outlook Integration & Sync page in Salesforce Setup are supported (`true`) or not (`false`). These domains are for users who access email using Outlook on the web. The default value is `true`. This field can only be used if the enableOutlookIntegration field is set to `true`.

Declarative Metadata Sample Definition

The following is an example of a EmailIntegrationSettings file.

1<?xml version="1.0" encoding="UTF-8"?>
2<EmailIntegrationSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3        <enableProductivityFeatures>true</enableProductivityFeatures>
4        <doesGmailStayConnectedToSalesforce>true</doesGmailStayConnectedToSalesforce>
5        <enableOutlookIntegration>true</enableOutlookIntegration>
6        <enableGmailIntegration>true</enableGmailIntegration>
7        <isLayoutCustomizationAllowed>true</isLayoutCustomizationAllowed>
8        <doesEmailLogAsEmailMessageInOutlook>false</doesEmailLogAsEmailMessageInOutlook>
9        <shouldUseTrustedDomainsList>false</shouldUseTrustedDomainsList>
10        <enableEmailTrackingInMobile>true</enableEmailTrackingInMobile>
11        <enableSupplementalContactInfoInMobile>false</enableSupplementalContactInfoInMobile>
12        <enableEngageForOutlook>true</enableEngageForOutlook>
13</EmailIntegrationSettings>

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>EmailIntegration</members>
5        <name>Settings</name>
6    </types>
7    <version>47.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.