JSON API » mailboxes » mailboxes/destinations/list
Gets array of fields of secondary destinations for a mailbox.
Input parameters
Requires authentication and the administrator, residential, or user role privileges.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| mailbox | String | Mailbox. | Yes | |
| customer | Integer | ID of customer owning mailbox. | No | Customer of authentication user. |
Responses
| Code | Description |
|---|---|
| 200 | Success. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
| 404 | The mailbox does not exist, or you do not have permission to view it. |
Data returned
An array of fields, corresponding to the rows of the mailbox_destinations table in the database.
Example: With required parameters
http://enswitch.example.com/api/json/mailboxes/destinations/list/?auth_username=user;auth_password=password;mailbox=1234{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "mailbox":"1235", "customer":2, ... }, { "mailbox":"1236", "customer":2, ... } ] }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |