Newer Version Available

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

EmailDomainFilter

Represents a filter that determines whether an email relay is restricted to a specific list of domains. This object is available in API version 43.0 and later.

Supported Calls

create()delete()describeSObjects()query()retrieve()update()upsert()

Special Access Rules

You must have the “Email Administration,” “Customize Application,” and “View Setup” user permissions to use this object.

The multiple email relay setting in Setup must be enabled before you can use this API. From Setup, enter Email Relay Activation, select Email Relay Activation, and then select Try it now! .

Fields

Field Name Details
EmailRelayId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description

The ID of the EmailRelay record.

FromDomain
Type
textarea
Properties
Create, Nillable, Update
Description

Restricts the email relay to send emails based on the sender domains (FromDomain) listed in this field. This field is optional, accepts a list of comma-separated values, and supports the wildcard character.

IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description

Indicates whether the email domain filter is active (true) or not (false). Use this field to enable or disable the email domain filter.

PriorityNumber
Type
int
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description

Indicates the order in which the email domain filter is processed. Filters are evaluated in ascending order. The priority number must be unique. If this field is left blank, it is assigned the next available number and is processed last.

ToDomain
Type
textarea
Properties
Create, Nillable, Update
Description

Restricts the email relay to send emails based on the recipient domains (ToDomain) listed in this field. This field is optional, accepts a list of comma-separated values, and supports the wildcard character.

Usage

Keep in mind that if you also plan to activate Bounce Management and Email Compliance Management, confirm with your email admin that your company allows relaying email sent from Salesforce. For more information on bounce management, see Configure Deliverability Settings for Emails Sent from Salesforce.

Tip