Corinne.chui: 1 revision

2016-05-30T19:36:04Z

1 revision

Jerry.dimitrov: /* Parameters */

2016-05-09T14:01:58Z

Parameters

Mike.robski: 1 revision: Release 109

2015-07-24T18:14:09Z

1 revision: Release 109

Corinne.chui: /* Paginated request */

2015-06-02T21:13:02Z

Paginated request

Show changes

Mike.robski: 1 revision: Release 91

2014-03-11T17:18:16Z

1 revision: Release 91

Mike.robski at 17:15, 11 March 2014

2014-03-11T17:15:10Z

Mike.robski: 1 revision: Release 87

2013-11-15T21:24:04Z

1 revision: Release 87

Stanimir.dimitrov: /* GET /accounts/{account}/email/{domain}/mailboxes */

2013-09-27T10:50:12Z

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

New page

= GET /accounts/{account}/email/{domain}/usernames =
Retrieves a list of mailboxes for a specific account and domain
__TOC__

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

==== Request Parameters ====
; account - ''string''
: The user account owning the domain and the mailboxes
; domain - ''string''
: The specific domain for which the call will retrieve the list

=== URI Parameters ===

; filterUsername - ''string''
: Only mailboxes with username matching the value of the parameter will be returned. The values used could be specified as a partial match with a wildcard(*).

; page - ''integer''
: Specifies which page should be displayed. Requires a pageSize parameter to also be provided

; pageSize - ''integer''
: Specifies the number of entries to be displayed on a page. Requires a page parameter to also be provided

; sortField - ''string''
: Specifies if the resulting list is to be sorted by a given field. Allowed values are '''username''' and '''quota'''

; sortOrder - ''string''
: The order in which the sorting is to be done. Allowed values are '''asc''' and '''desc'''

; details - ''integer''
: If set to '''1''' the type of mailbox users will be displayed for each mailbox

== 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 or account does not exist.

=== Response Body ===
<nowiki>
{
"list": [
{
"username": "{username}",
"master": {master},
"quota": {quota},
"webmailAccess": "{webmailAccess}",
"trialType": "{trialType}",
"trialExpiration": "{trialExpiration}"
}
],
"links": [
{
"href": "{href}",
"rel": "{rel}"
}
]
}
</nowiki>

==== Parameters ====
; username - ''string''
: The username of an individual mailbox

; master - ''integer''
: Allowed values are '''0''' or '''1'''

; quota - ''integer''
: The quota of the mailbox in Megabytes

; webmailAccess - ''string''
: (OPTIONAL)
: The type of webmail of the mailbox. Allowed values are '''standard''', '''activesync''' and '''premium'''. Will only be displayed if the user passed the details URI parameter

; trialType - ''string'' - one of "standard", "activesync" or "premium"
: Trial account type set for a given period of time. Values are standard, activesync, premium.

; trialExpiration - ''date'' - YYYY-mm-dd
: Expiration date of trial period formatted as YYYY-mm-dd.

; href - ''string''
: Link to other resources relevant to the mailboxes lists

; rel - ''string''
: Type of relation to the resource for the provided link

== Examples ==

=== Success scenario ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/usernames
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"username": "test",
"master": 1,
"quota": 10,
"trialType": "premium",
"trialExpiration": "2018-10-28"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/",
"rel": "self"
}
]
}
</nowiki>

=== Request with webmailAccess ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/usernames?details=1
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"username": "test",
"master": 1,
"quota": 10,
"webmailAccess": "standard"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/",
"rel": "self"
}
]
}
</nowiki>

=== Paginated request ===
'''Request'''
<nowiki>
GET accounts/test-account123/email/test.com/usernames?page=2&pageSize=2
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"username": "test1",
"master": 1,
"quota": 10
},
{
"username": "test2",
"master": 1,
"quota": 15
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=2&pageSize=2",
"rel": "self"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=1&pageSize=2",
"rel": "first"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=1&pageSize=2",
"rel": "previous"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=3&pageSize=2",
"rel": "next"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames?page=3&pageSize=2",
"rel": "last"
}
]
}
</nowiki>

== See also ==
* [[Email Service API|Email Service API]]

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

@@ Line 85: / Line 85: @@
 ; webmailAccess - ''string''
 : (OPTIONAL)
-: The type of webmail of the mailbox. Allowed values are '''standard''', '''activesync''' and '''premium'''. Will only be displayed if the user passed the details URI parameter
+: The type of webmail of the mailbox. Allowed values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]]. Will only be displayed if the user passed the details URI parameter
-; trialType - ''string'' - one of "standard", "activesync" or "premium"
+; trialType - ''string''
-: Trial account type set for a given period of time. Values are standard, activesync, premium.
+: Trial account type set for a given period of time. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]].
 ; trialExpiration - ''date'' - YYYY-mm-dd

@@ Line 194: / Line 194: @@
 == See also ==
-* [[Email Service API|Email Service API]]
+* [[Email API|Email API]]
 {{disqus}}
 [[Category:Hostway API]]
 [[Category:Email API]]

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