v1

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

Add email address to BoxTrapper forwarders

This function adds a list of email addresses to which BoxTrapper forwards email messages.

Important:

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

get/BoxTrapper/set_forwarders

Query parameters

emailstring required
Example:user@example.com

The account's email address.

Warning:

If you call this function in Webmail, the system ignores this parameter and uses the currently-authenticated email address.

forwarderstring[] required

The email addresses to which to forward email messages.

[
  "user1@example.com"
]

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": "set_forwarders",
  "module": "BoxTrapper",
  "result": {
    "status": 1
  }
}