Latest revision as of 07:53, 15 September 2014

[edit] GET /email/{domain}/usernames/{mailboxName}/secrets

Retrieves a list of text keys for all mailbox(alias) secret questions.

[edit] Request

GET /email/{domain}/usernames/{mailboxName}/secrets

[edit] Request Parameters

domain - string

The specific domain for which the call will retrieve the list

maiboxName - string

The name of the mailbox

[edit] Request Headers

Content-Type

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

[edit] Response

[edit] Status Code

200 OK

Success

404 Not Found

The domain name or mailbox does not exist.

[edit] Response Body

{
    "list": [ "{tk}", "{tk}", "{tk}" ],
    "links": [
        {
            "href": "https://api.hostway.com/email/{domain}/usernames/{mailboxName}/secrets",
            "rel": "self"
        }
    ]
}
 

[edit] Parameters

list - 'list'

A list of secret questions of the account

tk - string (Unique)

Unique secret question text key.

links - 'list'

Hypermedia to the account secret questions resource

[edit] Examples

[edit] Success scenario

Request

GET /email/test.com/usernames/test-mailbox/secrets
 

Response

{
    "list": [ "tk1", "tk2", "tk3" ],
    "links": [
        {
            "href": "https://api.hostway.com/email/test.com/usernames/test-mailbox/secrets",
            "rel": "self"
        }
    ]
}
 

[edit] See also

• Email API