Revision as of 11:23, 6 February 2015

GET /accounts/{account}/email/{domain}/blackwhitelist/{address}

Get black/white listed address details

Request

GET /accounts/{account}/email/{domain}/blackwhitelist/{address}

URI Parameters

account - string

domain - string

address - string

Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Content-Type

Required. Set this header to application/json; charset=UTF-8

Response

Status Code

200 OK

Success

401 Unauthorized

The supplied credentials are invalid or do not provide permissions for this operation.

404 Not Found

The domain name does not exist.

Response Body

{
    "type": "{type}",
    "address": "{address}",
    "links": {links}
}
 

Parameters

type - string

Type of address included in black/white list. Possible values are "W" or "B". "W" means the mailbox is included in "whitelist", "B" - included in "blacklist".

address - string

The address of the black/whitelisted mailbox.

links - list

Hypermedia to the get black/whitelisted address

Examples

Get address details

Request

GET /accounts/account-number/email/test.com/blackwhitelist/mb1-white20150114-0113@somedomain.com
 

Response

200 OK

{
    "type": "W",
    "address": "mb1-white20150114-0113@somedomain.com",
    "links": [{
        "href": "{{APIBaseURL}}/accounts/account-number/email/test.com/blackwhitelist/mb1-white20150114-0113@somedomain.com/",
        "rel": "self"
    }]
}