BoxTrapper
Spam Prevention (BoxTrapper)
Delete messages in the BoxTrapper queue
This function deletes messages in the BoxTrapper queue.
Important:
When you disable the Receive Mail role, the system disables this function.
get/BoxTrapper/delete_messages
Query parameters
emailstring email required
Example:user@example.com
The account's email address.
Warning:
If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.
queuefilestring required
Example:example.msg
The filename of the email message who's sender to delete.
Warning:
To delete multiple email message senders, duplicate the parameter name.
all_like1 | 0
Example:1
Whether to delete all messages that resemble the queuefile parameter's value.
- 1 - Delete all messages resembling the queuefile parameter.
- 0 - Do not delete all messages resembling the queuefile parameter.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "delete_messages",
"module": "BoxTrapper",
"result": {
"data": [
{
"email": "user@example.com",
"failed": 1,
"matches": [
"example.msg"
],
"operator": "delete",
"reason": "(XID d9myfd) The system failed to locate the requested message:",
"warning": 1
}
],
"metadata": {
"transformed": 1
},
"status": 1
}
}