EmailAuthorizationSettings

Represents your org’s email authorization settings.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

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

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

EmailAuthorizationSettings values are stored in the EmailAuthorization.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component.

Version 

Introduced in API version 66.0.

Fields 

enableSubstituteFromAddress 

  • Type: boolean
  • Required: No
  • Description: If true , Salesforce substitutes the From address to send outbound emails with unverified email domains. The outbound email uses the From address email@UniqueId.sfcustomeremail.com, where UniqueId is your org ID or Experience Cloud site ID. If false, Salesforce users and automations can send messages from Salesforce only when the email domain is verified. The default is false.

Declarative Metadata Sample Definition 

The following is an example of an EmailAuthorizationSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<EmailAuthorizationSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3  <enableSubstituteFromAddress>true</enableSubstituteFromAddress>
4</EmailAuthorizationSettings>

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