BoxTrapper
Spam Prevention (BoxTrapper)
Add email address to BoxTrapper allowed senders
This function whitelists email messages.
Important:
When you disable the Receive Mail role, the system disables this function.
Note:
To retrieve email messages in the BoxTrapper queue from senders that you did not previously whitelist, use the UAPI BoxTrapper::deliver_messages function.
get/BoxTrapper/whitelist_messages
Query parameters
queuefilestring required
Example:example.msg
The filename of the email message to whitelist.
Note:
To get a list of filenames in an account's BoxTrapper queue, use the UAPI BoxTrapper::list_queued_messages function.
Note:
To whitelist multiple email messages, duplicate this parameter.
emailstring email
Example:user@example.com
The cPanel account email address for which to whitelist messages.
Warning
If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "whitelist_messages",
"module": "BoxTrapper",
"result": {
"data": [
{
"email": "user@example.com",
"matches": [
"example.msg"
],
"operator": "whitelist"
}
],
"metadata": {
"transformed": 1
},
"status": 1
}
}