Loading...
Area: Optimizely Campaign
Applies to versions: Not applicable

BlacklistWebservice

Recommended reading 

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

Method Description

add

Adds an entry to the blocklist.

addAll

Adds multiple entries to the blocklist.

areBlacklisted

Queries whether mutiple email addresses are blocked.

contains

Queries whether an entry is contained in the blocklist.

containsAll

Queries whether multiple entries are contained in the blocklist.

getAllAdvanced

Queries all blocklist entries.

getAllAdvancedFlat

Queries all blocklist entries.

getAllEntries

Queries all blocklist entries.

getColumnNames

Queries the column names of each blocklist entry.

getCount

Counts all available blocklist entries.

getCreated

Queries the creation date of a blocklist entry.

getDataSet

Queries the data of each blocklist entry.

getDataSetFlat

Queries the values of each blocklist entry.

getFirstMatchingEntry

Queries the first blocklist entry that matches an email address.

getReason

Queries the reason for a blocklist entry.

isBlacklisted

Queries whether an email address is blocked.

remove

Deletes an entry from the blocklist.

removeAll

Deletes multiple entries from the blocklist.

Entries vs. email addresses

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

A single email address may be blocked by several blocklist entries. So, if you like to make sure that an email address is not blocked 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

Recommended reading