Email-domain-usernames-mailboxName-webmail:GET - Revision history

Mike.robski: 1 revision: Release 95

2014-07-02T05:58:44Z

1 revision: Release 95

Velimira.metodieva: /* Success getting account type */

2014-05-14T13:09:35Z

Success getting account type

Mike.robski: 1 revision: Release 87

2013-11-15T21:24:18Z

1 revision: Release 87

Stanimir.dimitrov: moved Email-domain-usernames-mailbox-webmail:GET to Email-domain-usernames-mailboxName-webmail:GET

2013-09-27T12:05:20Z

moved Email-domain-usernames-mailbox-webmail:GET to Email-domain-usernames-mailboxName-webmail:GET

New page

= GET /email/{domain}/usernames/{mailboxName}/webmail =
Gets OpenXchange account type.

__TOC__

== Request ==
<code>GET /email/{domain}/usernames/{mailboxName}/webmail</code>

=== URI Parameters ===
; domain - ''string''
:
; mailboxName - ''string''
:

=== Request Headers ===
{{EmailApiAuthorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

== 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 ===
<nowiki>
{
"type": "{type}",
"allowUpgrade": {allowUpgrade},
"links": [
{
"location": "{APIBaseURL}/email/{domain}/usernames/{mailboxName}/webmail/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; allowUpgrade - ''boolean''
: OpenXchange allowUpgrade option value.
; type - ''string'' - one of "standard", "activesync" or "premium"
: OpenXchange account type.

== Examples ==

=== Success getting account type ===
'''Request'''
<nowiki>
GET /email/test.com/usernames/test/webmail
</nowiki>

'''Response'''
<nowiki>
200 OK

{"type": "standard", "allowUpgrade": true, "links": [{"href": "{APIBaseURL}/email/test.com/usernames/test/webmail/", "rel": "self"}]}
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

@@ Line 36: / Line 36: @@
     "type": "{type}",
     "allowUpgrade": {allowUpgrade},
     "links": [
+       {
@@ Line 51: / Line 54: @@
 ; type - ''string'' - one of "standard", "activesync" or "premium"
 : OpenXchange account type.
 == Examples ==
@@ Line 64: / Line 73: @@
 OK
-{"type": "standard", "allowUpgrade": true, "links": [{"href": "{APIBaseURL}/email/test.com/usernames/test/webmail/", "rel": "self"}]}
+{"type": "standard", "allowUpgrade": true, "theme": "test_theme", "language": "en_US", "timezone": "America/Chicago", "links": [{"href": "{APIBaseURL}/email/test.com/usernames/test/webmail/", "rel": "self"}]}
 </nowiki>