blacklist and unblacklist
Blocklist entries can be individual recipients (i.e., an email address) or wildcards, which block all recipients that match a defined pattern (e.g., a whole domain). Use a question mark (?) for a single character and an asterisk (*) for several characters.
Note If the blocklist entry pattern contains special characters, the pattern must be URL-encoded. For example, use the code %2f for a forward slash (/), %252f for a double slash (//), %2B for a plus sign (+) etc.
These operations are available in the form service.
Parameters
Name | Mandatory | Default value | Description |
|---|---|---|---|
bmPattern | yes | – | If the blocklist entry refers to a single recipient, the email address can be set here. To blocklist multiple recipients, use wildcards as described above. |
bmReason | no | http-api | The reason for blocking. |
Return values
Value | Description |
|---|---|
ok | blocklist: Entry successfully added to the blocklist. unblocklist: Entry successfully removed from blocklist. |
ok: already_blacklisted | Only with bmVerbose=true: The entry already exists in the blocklist. |
ok: already_blacklisted | Only with bmVerbose=true: The entry already exists in the blocklist. |
wrong_tag | Authorization failed. Error codes:
|
missing_id | No bmRecipientId was transmitted (mandatory) when using the form service. |
system_error | A general error has occurred |
Example 1
.../form/.../blacklist?bmPattern=john.smith%40example.comThe recipient with the ID [email protected]_ is blocked.
Example 2
.../form/.../unblacklist?bmPattern=john.smith%40example.comThe recipient with the ID [email protected]_ is removed from the blocklist.
Example 3
.../form/.../blacklist?bmPattern=%2A%40example.comAll recipients with an email address containing the domain example.com are blocked.