Description
List Email forwarding addresses.

Request URL

Mail API v1.0

GET /v1/forwarding

Request Paramters

Parameter Value Style Type Description
X-Auth-Token - header string User Token
offset(Optional) - query int The number of the transactions to start displaying with (Default:0)
limit(Optional) - query int The number of transactions for displaying (Default:1000)
sort_key(Optional) create_date/address query string Sort Key (Default:create_date)
sort_type(Optional) asc/desc query string Sort Order (Default:asc)

Response Paramters

Parameter Value Style Type Description
forwarding - - list -
email_id - plain UUID Email ID
forwarding_id - plain UUID Forwarding ID
address - plain string Forwarding Address
total_count - plain int Total Count
current_count - plain int Current Count

Request Json

This operation does not accept a request body.

Normal response codes

200 - Success

Error response codes

401 - Access Denied
404 - Not Found

Repeatable

Yes

Example

curl -i -X GET \
-H "Accept: application/json" \
-H "X-Auth-Token: 39be9f8d53044388b7f2e867eba8b140" \
https://mail-hosting.tyo1.cloud.z.com/v1/forwarding?email_id=508bb370c78b7a
HTTP/1.1 200 Success
Date: Tue, 09 Dec 2014 01:46:58 GMT
Server: Apache
Content-Length: 1003
Content-Type: application/json

{
    "forwarding": [
        {
            "email_id": "508bb370c78b7a",
            "forwarding_id": "28e50414998f0ba",
            "address": "forward01@example.com"
        },
        {
            "email_id": "508bb370c78b7a",
            "forwarding_id": "p5a742zyidxgr5f",
            "address": "forward02@example.com"
        },
        {
            "email_id": "508bb370c78b7a",
            "forwarding_id": "ldz9ycw1dzqo4kh",
            "address": "forward03@example.com"
        }
    ],
    "total_count":100,
    "current_count":10
}