SandboxSettings

Represents Sandbox settings.

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 

SandboxSettings values are stored in the Sandbox.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 

SandboxSettings are available in API version 56.0 and later.

Fields 

disableSandboxExpirationEmails 

  • Type: boolean
  • Required: No
  • Description: Indicates whether to disable sandbox expiration email notifications for the source (production) org: true or false. When disabled in the source (production) org, users no longer receive email notifications for impending deletions of sandboxes that have been inactive for 180 days or longer.

sandboxDetailNewUIOptOut 

  • Type: boolean
  • Required: No

Declarative Metadata Sample Definition 

The following is an example of a SandboxSettings component.

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

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.