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.
queuefile required | string The filename of the email message to whitelist. Note: To get a list of filenames in an account's BoxTrapper queue, use the UAPI Note: To whitelist multiple email messages, duplicate this parameter. queuefile=queuefile=ex1.msg&queuefile=ex2.msg&queuefile=ex3.msg queuefile=example.msg |
string <email> 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. Example: email=user@example.com |
apiversion | integer The version of the API. |
func | string The name of the method called. |
module | string The name of the module called. |
object |
uapi --user=username BoxTrapper whitelist_messages queuefile='example.msg'
{- "apiversion": 3,
- "func": "whitelist_messages",
- "module": "BoxTrapper",
- "result": {
- "data": [
- {
- "email": "user@example.com",
- "matches": [
- "example.msg"
], - "operator": "whitelist"
}
], - "errors": null,
- "messages": null,
- "metadata": {
- "transformed": 1
}, - "status": 1,
- "warnings": null
}
}