Latest revision as of 00:58, 2 July 2014

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

Gets OpenXchange account type.

[edit] Request

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

[edit] URI Parameters

domain - string

mailboxName - string

[edit] Request Headers

Authorization - HTTP Authorization header [1]

Use the mailbox owner credentials for the specific mailbox, e.g. username: email@domain.com, password: secret

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

{
   "type": "{type}",
   "allowUpgrade": {allowUpgrade},
   "theme": "{theme}",
   "language": "{language}",
   "timezone": "{timezone}",
   "links": [
      {
         "location": "{APIBaseURL}/email/{domain}/usernames/{mailboxName}/webmail/", 
         "rel": "self"
      }
   ]
}
 

[edit] Parameters

allowUpgrade - boolean

OpenXchange allowUpgrade option value.

type - string - one of "standard", "activesync" or "premium"

OpenXchange account type.

theme - string

Theme identifier for setting a specific theme when creating an OX account

language - string

OpenXchange account locale of type 'en_US'.

timezone - string

OpenXchange account timezone of type 'America/Chicago'.

[edit] Examples

[edit] Success getting account type

Request

GET /email/test.com/usernames/test/webmail
 

Response

200 OK

{"type": "standard", "allowUpgrade": true, "theme": "test_theme", "language": "en_US", "timezone": "America/Chicago", "links": [{"href": "{APIBaseURL}/email/test.com/usernames/test/webmail/", "rel": "self"}]}