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.

Authorizations:
query Parameters
template
required
string

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.
Enum: "blacklist" "verify" "verifyreleased" "returnverify"
Example: template=verify
email
string <email>

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.

Example: email=user@example.com

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 \
  reset_email_template \
  template='verify'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "reset_email_template",
  • "module": "BoxTrapper",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}