Area:
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 |
|---|---|
|
Adds an entry to the blacklist. |
|
|
Adds multiple entries to the blacklist. |
|
|
Queries whether mutiple email addresses are blacklisted. |
|
|
Queries whether an entry is contained in the blacklist. |
|
|
Queries whether multiple entries are contained in the blacklist. |
|
|
Queries all blacklist entries. |
|
|
Queries all blacklist entries. |
|
|
Queries all blacklist entries. |
|
|
Queries the column names of each blacklist entry. |
|
|
Counts all available blacklist entries. |
|
|
Queries the creation date of a blacklist entry. |
|
|
Queries the data of each blacklist entry. |
|
|
Queries the values of each blacklist entry. |
|
|
Queries the first blacklist entry that matches an email address. |
|
|
Queries the reason for a blacklist entry. |
|
|
Queries whether an email address is blacklisted. |
|
|
Deletes an entry from the blacklist. |
|
|
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.
Last updated: Apr 24, 2018
