IPAddressRange

Represents a range of IP addresses to include in or exclude from the specified feature.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

IP Address Range components have the suffix .IPAddressRange and are stored in the IPAddressRanges folder.

Version

IPAddressRange components are available in API version 52.0 and later.

Special Access Rules

To access IpAddressRange, enable the HtmlEmail permission in your org.

Fields

Field Name	Description
Description	Field Type string Description The description of the IP address range. For example, the name of the company that owns the IP address range.
developerName	Field Type string Description Not required. Gives you a way to distinguish ipAddressRange entries among developers in your org.
endIpAddress	Field Type string Description The end of the IP address range. Must be an IPv4 or IPv6 Internet address and equal to or greater than the startIpAddress.
ipAddressFeature	Field Type picklist Description The feature that uses the range of IP addresses. Possible values are: `EmailIpFiltering` (default) —Filter email engagement activities such as email opens and email clicks.
ipAddressUsageScope	Field Type picklist Description Whether the specified IP addresses are included or excluded. Possible values are: `Exclusion` `Inclusion`
masterLabel	Field Type string Description Master label for the IP address range. This internal label doesn’t get translated.
startIpAddress	Field Type string Description The start of the IP address range. Must be an IPv4 or IPv6 Internet address and equal to or smaller than the endIpAddress.

Declarative Metadata Sample Definition

The following is an example of an ipAddressName component.

1<?xml version="1.0" encoding="UTF-8"?>
2<IPAddressRange xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>Filter emails from google.com</description>
4    <endIpAddress>221.224.222.158</endIpAddress>
5    <ipAddressFeature>EmailIpFiltering</ipAddressFeature>
6    <ipAddressUsageScope>Exclusion</ipAddressUsageScope>
7    <masterLabel>MasterLabelValue</masterLabel>
8    <startIpAddress>221.224.0.158</startIpAddress>
9    <isProtected>false</isProtected>
10</IPAddressRange>

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>*</members>
5        <name>IPAddressRange</name>
6    </types>
7    <version>1.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide