BlacklistWebservice

Recommended reading

With this web service you can query, update or remove blacklist entries in Episerver Campaign, as well as determine if a given email address is blacklisted.

Method	Description
add	Adds an entry to the blacklist.
addAll	Adds multiple entries to the blacklist.
areBlacklisted	Queries whether mutiple email addresses are blacklisted.
contains	Queries whether an entry is contained in the blacklist.
containsAll	Queries whether multiple entries are contained in the blacklist.
getAllAdvanced	Queries all blacklist entries.
getAllAdvancedFlat	Queries all blacklist entries.
getAllEntries	Queries all blacklist entries.
getColumnNames	Queries the column names of each blacklist entry.
getCount	Counts all available blacklist entries.
getCreated	Queries the creation date of a blacklist entry.
getDataSet	Queries the data of each blacklist entry.
getDataSetFlat	Queries the values of each blacklist entry.
getFirstMatchingEntry	Queries the first blacklist entry that matches an email address.
getReason	Queries the reason for a blacklist entry.
isBlacklisted	Queries whether an email address is blacklisted.
remove	Deletes an entry from the blacklist.
removeAll	Deletes multiple entries from the blacklist.

Entries vs. email addresses

Note that there is a difference between a blacklist entry and a blacklisted email address. Since blacklisting can be done using wildcards (see next section), a blacklist entry may blacklist several email addresses. To query the first matching blacklist entry for an email address, use the getFirstMatchingEntry method.

A single email address may be blacklisted by several blacklist entries. So, if you like to make sure that an email address is not blacklisted any more, the methods getFirstMatchingEntry and remove have to be invoked until getFirstMatchingEntry returns NULL.

Wildcards

An entry can contain the following wildcards:

An * (asterisk) represents one or more characters.
A ? represents a single character.

Examples

*@example.com: all email addresses of the domain "example.com".
john.do?@example.com: "john.doe@example.com" or "john.dos@example.com" etc.

Do you find this information helpful? Please log in to provide feedback.

Last updated: Apr 24, 2018