Latest revision as of 16:24, 15 November 2013

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

Get mailbox details.

[edit] Request

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

[edit] URI Parameters

account - string

domain - string

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

{ 
   "username": "{username}", 
   "master": {master},
   "quota": {quota},
   "usage": {usage},
   "authToken": {authToken},
   "links": [
      {
         "location": "{APIBaseURL}/accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/", 
         "rel": "self"
      }
   ]
   "sitemail_urls":
   [
     {
         "url": "http://sitemaildev7.test",
         "version": "7"
     },
     {
         "url": "http://sitemaildev8.test",
         "version": "8"
     }
   ]
}
 

[edit] Parameters

username - string

The mailbox username.

authToken - string

Authorization string for logging into OpenXchange

Returned only if long URL, starting with "/accounts" is used

master - boolean

Describes if this is a master account.

quota - integer

Mailbox quota in MB.

usage - integer

Mailbox usage in MB.

sitemail_urls - list

List containing maps of SiteMail URLs and their versions

[edit] Examples

[edit] Success getting mailbox details

Request

GET /accounts/test-account123/email/test.com/usernames/john.smith/mailbox
 

Response

200 OK

{
   "username": "test", 
   "authToken": "NGA8mH65N63ZpakAIYCWZodYRRbsOQ/Uj9TcnWWWaUYuHZliHZbmT2eDFQW2zV71PYmmMhUKlTx/5UMYkG4hv2ycGb0p7C2i4U8Vh1mK4/OrQQjQHLej27zfTMR+FB9FsSDGjcEUi6psAGdPa4EBSCWoaVE9B0M3", 
   "master": true, 
   "quota": 10, 
   "usage": 10, 
   "links": [
      {
         "href": "{APIBaseURL}/accounts/test-account123/email/test.com/usernames/john.smith/mailbox/", "rel": "self"
      }
   ]
   "sitemail_urls":[
      {
         "url": "http://sitemaildev7.test",
         "version": "7"
      },
      {
         "url": "http://sitemaildev8.test",
         "version": "8"
      }
   ]
}