Chat now with support
Chat with Support

Archive Manager 5.9.6 - RESTful API Service Guide

Common rules Advanced searches Alert service global setting Alert service policies Alert service queries Attachments Authentication (login) Configurations Contacts Delegations Exported searches Folders Groups Logins Login domains Mailboxes Mailstores Messages
.../v1/messages/schema.{format} .../v1/messages.{format} .../v1/messages/{messageId}.{format} .../v1/messages/{messageId}/html.{format} .../v1/messages/{messageId}/plaintext.{format} .../v1/messages/{messageId}/raw.{format} .../v1/messages/{messageId}/rtf.{format} .../v1/messages/{checksum}/bodyhtml .../v1/messages/{checksum}/eml .../v1/messages/{checksum}/sendmail.{format} .../v1/messages/{checksum}/web.{format} .../v1/messages/searchresults/schema.{format} .../v1/messages/rtfImage/{fileName} .../v1/messages/web/schema.{format} .../v1/messages/web.{format} .../v1/messages/{checksumOrId}/accesshistories.{format} .../v1/messages/{checksumOrId}/availabletags.{format} .../v1/messages/{checksumOrId}/comments.{format} .../v1/messages/{checksumOrId}/journalreports.{format} .../v1/messages/{checksumOrId}/tags.{format} .../v1/messages/{checksumOrId}/tags/{tagId}.{format}
Message comments Message folders Message tags Message types Organizational units Product Retention change logs Retention holds Retention message logs Retention policies Retention runs Retention run policies Retention schedule Retention settings Security roles Server Tags

Supported HTTP method

.../v1/logins/{loginId}/mailboxes.{format}

GET | POST

GET

Retrieves the mailboxes for a logged in user. The mailboxes can be Standard Mailbox (User, Group, Lync, PST, PublicFolder), or Custom Mailbox (Virtual).

Parameters:

•
queryId: A Base64 encoded value in the Response Header “X-QueryId”. It can be used to re-attach to a search result table or reissue a search result.
•
query
•
sort
•
top
•
lastId
•
offset
•
limit
•
fields

Query parameters:

•
name
•
mailBoxType
•
loginDomainName
•
mailServerType
•
organizationalUnit
•
loginId
•
notLoginId
•
loginDomainID
•
mailServerId
•
enableStoreManager
•
deleted
•
orgnizationalUnitId
•
mailStoreId
•
private
•
userAgreement
•
retentionRunID
•
retentionRunPolicyID
•
owner
•
excludeMailboxType
•
excludeMailServerType

JSON response sample

[
{
"id": 1,
"ownerLoginId": 2,
"loginDomainName": "DC2K8",
"ownerLoginName": "Administrator",
"uid": "75f6e283-6332-4e91-b811-cef20931f14b",
"name": "Administrator",
"mailBoxType": "User",
"mailServerName": "DC08",
"mailServerType": "Exchange",
"exchangeLegacyDn": "/o=dc2k8/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=Administrator",
"homeServerExchangeLegacyDn": "/o=dc2k8/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=DC08",
"lastScanTime": "2015-10-07T22:20:00-05:00",
"enableStoreManager": true,
"deleted": false
},
{
"id": 4,
"ownerLoginId": 2,
"loginDomainName": "DC2K8",
"ownerLoginName": "Administrator",
"uid": "00000000-0000-0000-0000-000000000000",
"name": "Home01",
"mailBoxType": "Virtual",
"lastScanTime": "0001-01-01T00:00:00",
"enableStoreManager": false,
"deleted": false
},
{
"id": 5,
"ownerLoginId": 2,
"loginDomainName": "DC2K8",
"ownerLoginName": "Administrator",
"uid": "00000000-0000-0000-0000-000000000000",
"name": "Home01",
"mailBoxType": "Virtual",
"lastScanTime": "0001-01-01T00:00:00",
"enableStoreManager": false,
"deleted": false
}
]

POST

Creates a list of mailboxes, then associates each mailbox to a specified login ID, and returns the list of the created mailboxes.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating