Enable spam box filtering for cPanel account

This function enables spam box filtering for a cPanel account. When you enable spam box filtering, the system sends messages marked as spam to a spam folder.

Notes:

This function requires that your hosting provider enables Apache SpamAssassin on the server.
To disable spam box filtering, use the UAPI Email::disable_spam_box function.
For more information, read our Spam Filters documentation.

Important:

When you disable the Spam Filter role, the system disables this function.

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/Email/enable_spam_box

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  enable_spam_box

Response samples

application/json

{"apiversion": 3,
"func": "enable_spam_box",
"module": "Email",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}