Enable or disable BoxTrapper for email account

This function enables or disables BoxTrapper for an email account.

Important:

When you disable the Receive Mail role, the system disables this function.

SecurityBasicAuth

Request

query Parameters

required	string or string The account's name. This can be an email address or the cPanel user’s username. 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
enabled required	integer Whether to enable or disable BoxTrapper for the email account. `1` - Enable BoxTrapper. `0` - Disable BoxTrapper. Enum: 0 1 Example: enabled=1

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/BoxTrapper/set_status

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  BoxTrapper \
  set_status \
  email='user@example.com' \
  enabled='1'

Response samples

application/json

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