Newer Version Available

This content describes an older version of this product. View Latest

EmailTemplateSettings

Represents an org’s email template settings. 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 for details.

File Suffix and Directory Location

EmailTemplateSettings values are stored in the EmailTemplate.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

EmailTemplateSettings is available in API version 47.0 and later.

Fields

Field Name Field Type Description
enableTemplateEnhancedFolderPref boolean Indicates whether Folders and Enhanced Sharing for Email Templates is enabled (true) or not (false). This feature allows users to create and manage folders for email templates.

Default value is false.

Declarative Metadata Sample Definition

The following is an example of the package file.

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

The package file references the following EmaillTemplate.settings file.

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

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.