Accounts-account-email-domain-usernames-mailboxName-forwards:GET

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

Gets forwarding for specified mailbox,domain and account.

Request

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

URI Parameters

account - string

domain - string

mailbox - 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

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

Parameters

target_mailbox - string

The returned forward target mailbox.

Examples

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>

See also

• Email API

blog comments powered by Disqus