Latest revision as of 14:36, 30 May 2016

[edit] GET /accounts/{account}/email/{domain}/webmailNames

Retrieves mapping of the allowed OX types with WebMail plan names for the target email domain resource. The result can be tied to a specific plan configuration on the product level.

Note: /email/{domain}/webmailNames is a shortcut equivalent of this resource

[edit] Request

GET /accounts/{account}/email/{domain}/webmailNames

[edit] URI Parameters

account - string

Account number for the owner of the email domain entity.

domain - string

Target domain name of the email domain resource.

[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

Returns dictionary which contains the mapping of supported OpenXchange types by text key and WebMail plan names for the specific email domain resource.

[edit] Status Code

200 OK

Success

[edit] Response Body

{
   "webmailNames": {
      "activesync": "SMX Sync Advanced", 
      "premium": "SMA Collaborate Premium", 
      "standard": "SMX Mail Basic"
   }, 
   "links": [
      {
         "href": "https://api.hostway.com/accounts/accNum123/email/example.com/webmailNames/", 
         "rel": "self"
      }
   ]
}
  

[edit] Parameters

webmailNames - dictionary

Dictionary containing the supported OX types by text key and the WebMail plan names.

links - list

Hypermedia for the resource.

[edit] See also

• Email API
• Common Features