Metadata API Developer Guide
jNewer Version Available
MailMergeSettings
File Suffix and Directory Location
A MailMerge component file has the suffix MailMerge.settings and is stored in the settings directory.
Version
MailMergeSettings components are available in API version 51.0 and later. Before API version 51.0, fields from MailMergeSettings were found within OrgSettings components.
Fields
| Field Name | Field Type | Descriptions |
|---|---|---|
| enableExtendedMailMerge | boolean | Indicates whether the Salesforce Classic product, Extended Mail Merge, is enabled (true) or not (false). Use Extended Mail Merge to generate Microsoft Word documents — such as form letters or address labels — from Salesforce records using Word document templates. Default value is false. |
| saveMailMergeDocsAsSalesforceDocs | boolean | Indicates whether mail-merged documents are saved to the My Personal Documents folder of the user who generated the mail merge. (true) or not (false). If (false), only documents over 3 MB are saved to the user’s documents folder. Smaller documents are emailed to the user. Default value is (false). |
Declarative Metadata Sample Definition
The following is an example of a MailMergeSettings component.
1<?xml version="1.0" encoding="UTF-8"?>
2<MailMergeSettings xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3 <enableExtendedMailMerge>true</enableExtendedMailMerge>
4</MailMergeSettings>Example Package Manifest
The following is an example package manifest used to deploy or retrieve mail merge settings metadata for an organization:
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <name>MailMergeSettings</name>
5 </types>
6 <version>51.0</version>
7</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.