This function retrieves a list of BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender.
Important:
When you disable the Receive Mail role, the system disables this function.
| email required | string <email> A valid email address on the cPanel account. Warning: If you call this function in Webmail, the system overrides this parameter. This parameter defaults to the current email address. Example: [email protected] |
uapi --output=jsonpretty \ --user=username \ BoxTrapper \ get_blocklist \ email='[email protected]'
{- "apiversion": 3,
- "func": "get_blocklist",
- "module": "BoxTrapper",
- "result": {
- "data": [
- "from blocklisted-email\\@domain\\.com"
], - "errors": null,
- "messages": null,
- "metadata": { },
- "status": 1,
- "warnings": null
}
}