v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
BoxTrapper
Spam Prevention (BoxTrapper)

Restore default BoxTrapper email message template

This function restores the BoxTrapper email message templates to the system default setting.

Important:

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

get/BoxTrapper/reset_email_template

Query parameters

template'blacklist' | 'verify' | 'verifyreleased' | 'returnverify' required
Example:verify

The message template. Possible values:

  • blacklist - BoxTrapper responds with this message when a blacklisted address sends an email.
  • verify - BoxTrapper responds with this message when an address that does not exist on the whitelist or blacklist sends an email. This message requests a response to confirm that the sender is legitimate.
  • verifyreleased - BoxTrapper responds with this message when a person responds to the verify message with an email or a click on the verification link.
  • returnverify - BoxTrapper responds with this message when the verification process fails.
emailstring email
Example:user@example.com

The account's email address.

Warning:

The email parameter is required when this function is called outside of webmail. If you call this function in Webmail, the email parameter is not required, and the system overrides this parameter with the current authenticated user's email address.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "reset_email_template",
  "module": "BoxTrapper",
  "result": {
    "status": 1
  }
}