Return all BoxTrapper forwarders

This function retrieves 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 <email>

The account's email address.

Important:

If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated 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 \
  get_forwarders \
  email='user@example.com'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_forwarders",
  • "module": "BoxTrapper",
  • "result": {
    • "data": [
      • "user1@example.com, user2@example.com, user3@example.com"
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}