BoxTrapper
Spam Prevention (BoxTrapper)
Send messages in the BoxTrapper queue
This function delivers messages in the BoxTrapper queue.
Important:
When you disable the Receive Mail role, the system disables this function.
get/BoxTrapper/deliver_messages
Query parameters
emailstring email required
Example:user@example.com
The sender's cPanel account email address for which to deliver email messages.
Warning:
If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.
queuefilestring required
The filename of the email messages to deliver.
Note:
To deliver multiple email messages, pass this parameter multiple times.
all_like0 | 1
Example:1
Whether to deliver all messages that resemble the queuefile parameter's value.
- 1 - Deliver all similar messages.
- 0 - Don't deliver all similar messages.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "deliver_messages",
"module": "BoxTrapper",
"result": {
"data": [
{
"email": "user@example.com",
"failed": 1,
"matches": [
"example.msg"
],
"operator": "deliverall",
"reason": "This is a failure message.",
"warning": 1
}
],
"metadata": {
"transformed": 1
},
"status": 1
}
}