# 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.

Endpoint: GET /BoxTrapper/set_forwarders
Version: 11.136.0.25
Security: BasicAuth

## Query parameters:

  - `email` (string, required)
    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: "user@example.com"

  - `forwarder` (array, required)
    The email addresses to which to forward email messages.
    Example: ["user1@example.com"]

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "set_forwarders"

  - `module` (string)
    The name of the module called.
    Example: "BoxTrapper"

  - `result` (object)

  - `result.data` (object,null)

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.status` (integer)
    - 1 - Success
- 0 - Failed: Check the errors field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.