Latest revision as of 14:36, 30 May 2016

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

Gets OpenXchange account type.

[edit] Request

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

[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

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

[edit] Parameters

authenticationToken - string

Authentication token value

allowUpgrade - boolean

OpenXchange allowUpgrade option

type - string

OpenXchange account type. Supported values can be obtained from the webmailNames API endpoint.

resetPassword - boolean

Returns if customer will be forced to reset mailbox password the next time he logs in to his OX account

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 /accounts/test/email/test.com/usernames/john.smith/webmail
 

Response

200 OK

{
   "authToken": "PoiC9iyBehe13ZHWyhfa2eArKUJy+RJ5WpyN0eCBs2+Ns8SIdvhgto9zWLDnGZWlgTV9MuJ1F+//XnoKZWxjaRr2qh++437fChyxZmaHwe7g==",
   "type": "standard", 
   "allowUpgrade": true, 
   "resetPassword": false,
   "theme": "test_theme", 
   "language": "en_US", 
   "timezone": "America/Chicago",
   "links": [
      {
         "href": "{APIBaseURL}/accounts/test/email/test.com/usernames/john.smith/webmail/", 
         "rel": "self"
      }
   ]
}