---
schema_version: "1"
id: 736dbcf2b40339db68a5fc6ebda82f543ae21d697d5e866181ac72a1d2f28e8a
title: EmailIntegrationSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_emailintegrationsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_emailintegrationsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 7e3bcdb54d9b4fc00b475976db17bf35c20f048a223b359ec6a41ac1fc957e5f
description: Represents an org’s settings for the Outlook integration, Gmail integration, and Salesforce Inbox. This type extends the Metadata metadata type and inherits its fullName field.
---
# EmailIntegrationSettings

Represents an org’s settings for the Outlook integration, Gmail integration, and Salesforce Inbox. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for 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’s only one settings file for each settings component.

## Version

EmailIntegrationSettings fields are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d409095e104">Field Name</th>

              <th class="featureTableHeader  " id="d409095e107">Field Type</th>

              <th class="featureTableHeader  " id="d409095e110">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">doesEmailLogAsEmailMessageInOutlook</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether the Outlook integration logs emails to the Email Message
                object (<samp class="codeph nolang">true</samp>) or as tasks (<samp class="codeph nolang">false</samp>). The default value is <samp class="codeph nolang">true</samp>. <p class="p">This field can only be used if the
                  <span class="keyword parmname">enableOutlookIntegration</span> field is set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">doesGmailStayConnectedToSalesforce</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Gmail integration users log in to Salesforce from Gmail each
                time their session expires. If set to <samp class="codeph nolang">true</samp>,
                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 <samp class="codeph nolang">false</samp>, users log in to Salesforce from the Gmail
                integration each time their Salesforce session expires. The default value is <samp class="codeph nolang">false</samp>. <p class="p">This field can only be used if the
                  <span class="keyword parmname">enableGmailIntegration</span> field is set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableContactAndEventSync</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether users can sync calendar events and contacts between
                Salesforce and their Microsoft and Google accounts ( <samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Lightning
                Sync or Einstein Activity Capture must be enabled to use this feature. The default
                value is <samp class="codeph nolang">false</samp>.<p class="p">Available in API version 48.0
                  and later. </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableContextualEverywhere</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">
                <p class="p">Indicates whether contextual insights in Sales Cloud Everywhere, available in the
                  Salesforce Chrome extension, are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">This field is available in API version 58.0 and later. </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableEmailTrackingInMobile</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Salesforce Inbox users can track emails (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>) 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 <samp class="codeph nolang">true</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableEngageForOutlook</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Engage For Outlook is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to
                <samp class="codeph nolang">true</samp>, Engage users can connect their Outlook
                account and send Engage emails from their Outlook inbox.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableExtensionHostUnrestricted</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether the contextual web experience is enabled in the chrome
                extension or not.</td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableGmailIntegration</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether the Gmail integration is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to
                <samp class="codeph nolang">true</samp>, G Suite users with the Gmail
                integration can connect their Gmail account and work with Salesforce data in their
                email. The default value is <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableInboxInternalEmailTracking</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">
                <p class="p">Indicates whether a read-receipt status is shown for emails that are sent within
                  the same domain (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">This field is available in API version 58.0 and later. </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableInboxMobileIntune</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Inbox is enabled to use Microsoft Intune to manage security
                settings (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to <samp class="codeph nolang">true</samp>, Inbox mobile users need a Microsoft Intune license to log in to
                the app. The default value is <samp class="codeph nolang">false</samp>.<p class="p">Available in API version 50.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableOutlookIntegration</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether the Outlook integration is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to <samp class="codeph nolang">true</samp>, Outlook
                users with the Outlook integration can connect their Outlook account and work with
                Salesforce data in their email. The default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableProductivityFeatures</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Inbox features, such as Availability and Send later, are
                available (<samp class="codeph nolang">true</samp>) or not available (<samp class="codeph nolang">false</samp>) in the Outlook or Gmail integration. The
                default value is <samp class="codeph nolang">false</samp>.<p class="p">This field can only
                  be used if either the <span class="keyword parmname">enableOutlookIntegration</span> or
                  <span class="keyword parmname">enableGmailIntegration</span> field is set to <samp class="codeph nolang">true</samp> and if the org has an Inbox
                  license.
                </p>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>To see Inbox features, users must also have either the Inbox
                            with Einstein Activity Capture or the Inbox without Einstein Activity capture
                            permission set.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">enableSupplementalContactInfoInMobile</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Salesforce Inbox mobile app users see third-party contact
                information when contacts are shown (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>) in the Inbox mobile app. The
                default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">isLayoutCustomizationAllowed</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether Salesforce admins are allowed (<samp class="codeph nolang">true</samp>) or not allowed (<samp class="codeph nolang">false</samp>) 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 <samp class="codeph nolang">true</samp>.<p class="p">This field can only be
                  used if either the <span class="keyword parmname">enableOutlookIntegration</span> or
                  <span class="keyword parmname">enableGmailIntegration</span> field is set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">orgIsSyncingEventsOutbound</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates whether changes to Salesforce events sync to Outlook and Google
                calendars <samp class="codeph nolang">(true</samp>) or not (<samp class="codeph nolang">false</samp>).<div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>This field is set by Salesforce. We do
                            not recommend that you set this field manually, as doing so may cause
                            interruptions in your org's event syncing.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
                <p class="p">This field is available in API
                  version 50.0 and later</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"></td>

              <td class="entry" headers="d409095e107" data-title="Field Type"></td>

              <td class="entry" headers="d409095e110" data-title="Description"></td>

            </tr>

            <tr>
              <td class="entry" headers="d409095e104" data-title="Field Name"><span class="keyword parmname">shouldUseTrustedDomainsList</span></td>

              <td class="entry" headers="d409095e107" data-title="Field Type">boolean</td>

              <td class="entry" headers="d409095e110" data-title="Description">Indicates if the web domains listed in the Outlook Integration &amp; Sync page
                in Salesforce Setup are supported (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). These domains are for users who
                access email using Outlook on the web. The default value is <samp class="codeph nolang">true</samp>.<p class="p">This field can only be used if the
                  <span class="keyword parmname">enableOutlookIntegration</span> field is set to <samp class="codeph nolang">true</samp>.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a EmailIntegrationSettings file.

<?xml version="1.0" encoding="UTF-8"?>
<EmailIntegrationSettings xmlns="http://soap.sforce.com/2006/04/metadata">
        <enableContactAndEventSync\>true</enableContactAndEventSync\>
        <enableProductivityFeatures\>true</enableProductivityFeatures\>
        <doesGmailStayConnectedToSalesforce\>true</doesGmailStayConnectedToSalesforce\>
        <enableOutlookIntegration\>true</enableOutlookIntegration\>
        <enableGmailIntegration\>true</enableGmailIntegration\>
        <isLayoutCustomizationAllowed\>true</isLayoutCustomizationAllowed\>
        <doesEmailLogAsEmailMessageInOutlook\>false</doesEmailLogAsEmailMessageInOutlook\>
        <shouldUseTrustedDomainsList\>false</shouldUseTrustedDomainsList\>
        <enableEmailTrackingInMobile\>true</enableEmailTrackingInMobile\>
        <enableSupplementalContactInfoInMobile\>false</enableSupplementalContactInfoInMobile\>
        <enableEngageForOutlook\>true</enableEngageForOutlook\>
</EmailIntegrationSettings\>

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>EmailIntegration</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).