Mike.robski: 1 revision: Release 100

2014-11-19T05:10:24Z

1 revision: Release 100

Velimira.metodieva at 10:52, 4 November 2014

2014-11-04T10:52:48Z

New page

= GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange/messagestats =
Retrieves exchange message count for INBOX, SENT and SPAM folders

__TOC__

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

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

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

== 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 the mailbox does not exist.
: Unable to get message count for virtual mailboxes.

; 500 Internal Server Error
: Missing Domain or Installation records

; 502 Bad Gateway
: Unable to get message count. No IMAP connection
: Unable to get message count. IMAP search operation failed.
: Unable to get message count. IMAP folder selection failed.

=== Response Body ===
<nowiki>
{
"messageCount" : {
"inbox" : {
"allMessages" : {inbox_all_messages_count},
"unreadMessages" : {inbox_unread_messages_count}
},
"sent" : {
"allMessages" : {sent_all_messages_count},
"unreadMessages" : {sent_unread_messages_count}
},
"spam" : {
"allMessages" : {spam_all_messages_count},
"unreadMessages" : {sent_unread_messages_count}
}
},
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange/messagestats/, "rel": "self"}]
}
</nowiki>

==== Parameters ====
; inbox_all_messages_count- ''integer''
: All messages for INBOX folder

; inbox_unread_messages_count- ''integer''
: Unread messages for INBOX folder

; sent_all_messages_count- ''integer''
: All messages for SENT folder

; sent_unread_messages_count- ''integer''
: Unread messages for SENT folder

; spam_all_messages_count- ''integer''
: All messages for SPAM folder

; spam_unread_messages_count- ''integer''
: Unread messages for SPAM folder

== Examples ==

=== Success ===
'''Request'''
<nowiki>
GET /accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange/messagestats
</nowiki>

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

{
"messageCount" : {
"inbox" : {
"allMessages" : 3,
"unreadMessages" : 3
},
"sent" : {
"allMessages" : 0,
"unreadMessages" : 0
},
"spam" : {
"allMessages" : 0,
"unreadMessages" : 0
}
},
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange/messagestats/", "rel": "self"}]
}
</nowiki>

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

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

Accounts-account-email-domain-usernames-mailboxName-exchange-messagestats:GET - Revision history

Mike.robski: 1 revision: Release 100

Velimira.metodieva at 10:52, 4 November 2014