v1

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

Return specified BoxTrapper email template

This function retrieves a BoxTrapper email message template.

Important:

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

get/BoxTrapper/get_email_template

Query parameters

emailstring email required
Example:user@example.com

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.

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

The message template.

  • blacklist
  • returnverify
  • verifyreleased
  • verify

Note:

For more information on each template, read our BoxTrapper documentation.

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": "get_email_template",
  "module": "BoxTrapper",
  "result": {
    "data": "To: %email%\\nSubject: Re: %subject%\\n\\nThe user %acct% does not accept mail from your address.\\n\\nThe headers of the message sent from your address are shown below:\\n\\n%headers%\\n\",",
    "status": 1
  }
}