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.

Authorizations:
query Parameters
email
required
string

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.

Example: email=user@example.com
forwarder
required
Array of any <email>

The email addresses to which to forward email messages.

Example: forwarder=user1@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 \
  set_forwarders \
  email='user@example.com' \
  forwarder='user1@example.com'

Response samples

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