Mike.robski: 1 revision: Release 87

2013-11-15T21:24:25Z

1 revision: Release 87

Stanimir.dimitrov: moved Accounts-account-email-domain-usernames-mailbox:GET to Accounts-account-email-domain-usernames-mailboxName-mailbox:GET

2013-09-27T12:00:31Z

moved Accounts-account-email-domain-usernames-mailbox:GET to Accounts-account-email-domain-usernames-mailboxName-mailbox:GET

New page

= GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox =
Get mailbox details.

__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox</code>

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

=== Request Headers ===
{{Authorization}}

; 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>
{
"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"
}
]
}
</nowiki>

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

== Examples ==

=== Success getting mailbox details ===
'''Request'''
<nowiki>
GET /accounts/test-account123/email/test.com/usernames/john.smith/mailbox
</nowiki>

'''Response'''
<nowiki>
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"
}
]
}
</nowiki>

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

Accounts-account-email-domain-usernames-mailboxName-mailbox:GET - Revision history

Mike.robski: 1 revision: Release 87

Stanimir.dimitrov: moved Accounts-account-email-domain-usernames-mailbox:GET to Accounts-account-email-domain-usernames-mailboxName-mailbox:GET