EmailIntegrationSettings

Represents an org’s settings for the Outlook integration, Gmail integration, and Salesforce Inbox.

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

This type extends Metadata and inherits its fields.

EmailIntegrationSettings values are stored in the EmailIntegration.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.

EmailIntegrationSettings fields are available in API version 47.0 and later.

• Type: boolean

• Required: No

• Description: 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.

• Type: boolean

• Required: No

• Description: Indicates whether Gmail integration users log in to Salesforce from Gmail each time their session expires. If set to true, users log in from the Gmail integration one time, 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.

• Type: boolean
• Required: No
• Introduced: API version 48.0
• Description: Indicates whether users can sync calendar events and contacts between Salesforce and their Microsoft and Google accounts ( true) or not (false). Lightning Sync or Einstein Activity Capture must be enabled to use this feature. The default value is false.

• Type: boolean
• Required: No
• Introduced: API version 58.0
• Description: Indicates whether contextual insights in Sales Cloud Everywhere, available in the Salesforce Chrome extension, are enabled (true) or not (false).

• Type: boolean
• Required: No
• Description: Indicates whether Salesforce Inbox users can track emails (true) or not (false) while in the Outlook integration with Inbox or the Gmail integration with Inbox. It also controls email tracking in the Inbox mobile app and legacy versions of Inbox. The default value is true.

• Type: boolean
• Required: No
• Description: 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.

• Type: boolean
• Required: No
• Description: Indicates whether the contextual web experience is enabled in the chrome extension or not.

• Type: boolean
• Required: No
• Description: 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.

• Type: boolean
• Required: No
• Introduced: API version 58.0
• Description: Indicates whether a read-receipt status is shown for emails that are sent within the same domain (true) or not (false).

• Type: boolean
• Required: No
• Introduced: API version 50.0
• Description: Indicates whether Inbox is enabled to use Microsoft Intune to manage security settings (true) or not (false). When set to true, Inbox mobile users need a Microsoft Intune license to log in to the app. The default value is false.

• Type: boolean
• Required: No
• Description: 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.

• Type: boolean
• Required: No

• Type: boolean

• Required: No

• Description: 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.

• Type: boolean
• Required: No
• Description: 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.

• Type: boolean

• Required: No

• Description: 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.

• Type: boolean
• Required: No
• Introduced: API version 50.0
• Description: Indicates whether changes to Salesforce events sync to Outlook and Google calendars (true) or not (false).

• Type: boolean

• Required: No

• Description: 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.

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        <enableContactAndEventSync>true</enableContactAndEventSync>
4        <enableProductivityFeatures>true</enableProductivityFeatures>
5        <doesGmailStayConnectedToSalesforce>true</doesGmailStayConnectedToSalesforce>
6        <enableOutlookIntegration>true</enableOutlookIntegration>
7        <enableGmailIntegration>true</enableGmailIntegration>
8        <isLayoutCustomizationAllowed>true</isLayoutCustomizationAllowed>
9        <doesEmailLogAsEmailMessageInOutlook>false</doesEmailLogAsEmailMessageInOutlook>
10        <shouldUseTrustedDomainsList>false</shouldUseTrustedDomainsList>
11        <enableEmailTrackingInMobile>true</enableEmailTrackingInMobile>
12        <enableSupplementalContactInfoInMobile>false</enableSupplementalContactInfoInMobile>
13        <enableEngageForOutlook>true</enableEngageForOutlook>
14</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>

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.