Latest revision as of 15:24, 15 November 2013

[edit] GET accounts/{account}/email/{domain}/usernames/{mailbox}/forwards

Gets forwarding for specified mailbox,domain and account.

[edit] Request

GET accounts/{account}/email/{domain}/usernames/{mailbox}/forwards

[edit] URI Parameters

account - string

domain - string

mailbox - string

[edit] 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

[edit] Response

[edit] 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.

[edit] Response Body

{
   "targets": [
      {
         "target":"{target_mailbox}"
      }, 
      {
         "target":"{target_mailbox}"
      }
   ],
   "links": [
      {
         "location": "{APIBaseURL}/accounts/{account}/email/{domain}/usernames/{mailbox}/forwards/", 
         "rel": "self"
      }
   ]
}
 

[edit] Parameters

target_mailbox - string

The returned forward target mailbox.

[edit] Examples

[edit] Sucess getting forwarding info

Request

GET accounts/{account}/email/test.com/usernames/test/forwards
 

Response

200 OK

 <nowiki>
{
   "targets": [
      {
         "target":"mb1@test.com"
      }, 
      {
         "target":"test@test-forward.com"
      }
   ],
   "links": [
      {
         "location": "{APIBaseURL}/accounts/{account}/email/{domain}/usernames/{mailbox}/forwards/", 
         "rel": "self"
      }
   ]
}
 
</nowiki>

[edit] See also

• Email API