Overview | Service | Command |
Return all mailboxes
Returns all data from the mailbox table (in db.sql), except for the "comment" column.
Authorization token required | true |
Admin Authorization token required | true |
<GetAllMailboxesRequest [limit="{max-number-of-mailboxes} (Long)"] [offset="{starting-offset} (Long)"] /> ## GetAllMailboxesRequest
The following table describes elements and attributes you can define within a
<GetAllMailboxesRequest>
element:
XPath | Required / Optional | Description |
@limit | Optional (0 or 1) | Type:Long The number of mailboxes to return (0 is default and means all) |
@offset | Optional (0 or 1) | Type:Long The starting offset (0, 25, etc) |
<GetAllMailboxesResponse more="{more-flag} (0|1)" searchTotal="{search-total} (int)"> ## GetAllMailboxesResponse
(<mbox id="(int)" groupId="(int)" accountId="..." indexVolumeId="(short)" itemIdCheckPoint="(int)"
contactCount="(int)" sizeCheckPoint="(long)" changeCheckPoint="(int)" trackingSync="(int)"
trackingImap="(0|1)" [lastbackupat="(Integer)"] lastSoapAccess="(int)" newMessages="(int)" /> ## MailboxInfo)*
</GetAllMailboxesResponse>
The following table describes elements and attributes you can define within a
<GetAllMailboxesResponse>
element:
XPath | Required / Optional | Description |
@more | Required (only 1) | Type:0|1 1 (true) if more mailboxes left to return |
@searchTotal | Required (only 1) | Type:int Total number of mailboxes that matched search (not affected by limit/offset) |
/mbox | Optional (0 or more) | Mailboxes |
/mbox@id | Required (only 1) | Type:int ID |
/mbox@groupId | Required (only 1) | Type:int Group ID |
/mbox@accountId | Required (only 1) | Type:String Account ID |
/mbox@indexVolumeId | Required (only 1) | Type:short Index volume ID |
/mbox@itemIdCheckPoint | Required (only 1) | Type:int Item ID checkpoint |
/mbox@contactCount | Required (only 1) | Type:int Contact count |
/mbox@sizeCheckPoint | Required (only 1) | Type:long Size checkpoint |
/mbox@changeCheckPoint | Required (only 1) | Type:int Change checkpoint |
/mbox@trackingSync | Required (only 1) | Type:int Tracking Sync |
/mbox@trackingImap | Required (only 1) | Type:0|1 Tracking IMAP |
/mbox@lastbackupat | Optional (0 or 1) | Type:Integer Last Backup At |
/mbox@lastSoapAccess | Required (only 1) | Type:int Last SOAP access |
/mbox@newMessages | Required (only 1) | Type:int New Messages |