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.

Authorizations:
query Parameters
email
required
string <email>

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.

Example: email=user@example.com
template
required
string

The message template.

  • blacklist
  • returnverify
  • verifyreleased
  • verify

Note:

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

Enum: "blacklist" "returnverify" "verifyreleased" "verify"
Example: template=verify

Responses

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

Request samples

uapi --output=jsonpretty \
  --user=username \
  BoxTrapper \
  get_email_template \
  email='user@example.com' \
  template='verify'

Response samples

Content type
application/json
{
  • "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\",",
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}