Delete spam box contents

This function clears the spam box of all its contents for all email accounts.

Important:

This function deletes the Spam Box folder contents for every email address on the account, which includes the system user email account.

SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/SpamAssassin/clear_spam_box
Request samples
uapi --output=jsonpretty \
  --user=username \
  SpamAssassin \
  clear_spam_box
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "clear_spam_box",
  • "module": "SpamAssassin",
  • "result": {
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}