BoxTrapper
Spam Prevention (BoxTrapper)
Run a specific BoxTrapper action for a message
This function performs a specified action on messages in the BoxTrapper queue.
Important:
When you disable the Receive Mail role, the system disables this function.
get/BoxTrapper/process_messages
Query parameters
action'deliver' | 'deliverall' | 'delete' | 'deleteall' | 'blacklist' | 'whitelist' | 'ignore' required
Example:blacklist
The action to perform on the email message file. To perform multiple actions on the specified email messages, pass this parameter multiple times.
- deliver — Deliver a specific message.
- deliverall — Deliver all messages from a sender.
- delete — Delete a message.
- deleteall — Delete all messages from a sender.
- blacklist — Blacklist the sender of an email message.
- whitelist — Whitelist the sender of an email message.
- ignore — Ignore email messages from a sender.
Note:
The function performs the actions on the email messages files in the order that you pass each action.
queuefilestring required
Example:example.msg
The filename of the email message to process. To process multiple email messages, pass this parameter multiple times.
emailstring email
Example:user@example.com
The account's email address.
Warning:
- The email parameter is required when this function is called outside of Webmail.
- If you call this function in Webmail, the email parameter is not required, and the system overrides this parameter with the current authenticated user's email address.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "process_messages",
"module": "BoxTrapper",
"result": {
"data": [
{
"failed": 1,
"operator": "delete"
}
],
"metadata": {
"transformed": 1
},
"status": 1
}
}