GET api/v1/systems/{systemPhoneNumber}/mailboxes/{mailboxNumber}/foldersWithCounts

Returns the folders of a mailbox with information on each folder with unread counts given the default phone number and mailbox number.

Request Information

URI Parameters

Name	Description	Type	Additional information
systemPhoneNumber		string	Required
mailboxNumber		integer	Required

Body Parameters

None.

Response Information

Resource Description

200 status code will be returned for successful along with list folder information. 402 status code will be returned if system number is on hold. 403 status code will be returned if user does not have access to account with the system number specified or mailbox specified.

Collection of MessageFolderWithCounts

Name	Type	Additional information
Name	string	None.
MessageCount	integer	None.
UnreadMessages	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "MessageCount": 2,
    "UnreadMessages": 3
  },
  {
    "Name": "sample string 1",
    "MessageCount": 2,
    "UnreadMessages": 3
  }
]

application/xml, text/xml

Sample:

<ArrayOfMessageFolderWithCounts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.WebLink.Models">
  <MessageFolderWithCounts>
    <MessageCount>2</MessageCount>
    <Name>sample string 1</Name>
    <UnreadMessages>3</UnreadMessages>
  </MessageFolderWithCounts>
  <MessageFolderWithCounts>
    <MessageCount>2</MessageCount>
    <Name>sample string 1</Name>
    <UnreadMessages>3</UnreadMessages>
  </MessageFolderWithCounts>
</ArrayOfMessageFolderWithCounts>