Getting Mailboxes
You can get a resource representation of a specific organization mailbox to explore and restore data.
Request
GET https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
restoreSessionId | string | Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions. |
mailboxId | string | Specifies the identification number of the mailbox. For more information on how to get this parameter, see Getting Mailboxes. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
In the response body, the server returns a resource representation of the /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId} resource. The response body contains the following properties:
Property | Type | Description |
|---|---|---|
id | string | Specifies the ID of the organization backed-up mailbox. |
string | Specifies the email address of the organization backed-up mailbox. | |
name | string | Specifies the name of the organization backed-up mailbox. |
isArchive | boolean | If set to true, indicates that the mailbox is of the Archive type. |
isPublic | boolean | If set to true, indicates that the mailbox is public. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
_actions | Dictionary of string [key] and Object [value] | Links to related actions (navigation property). |
Example
The example returns a resource representation of the organization mailbox with the ID 9e9b7199-f547-467a-b580-9d283a75eaad.
Request: GET https://abc.tech.local:4443/v6/RestoreSessions/9f786f0f-de9a-4a90-8118-093b6cb2c4fc/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "id": "9e9b7199-f547-467a-b580-9d283a75eaad", "name": "support.south", "email": "support.south@westsupport.com", "isArchive": false, "isPublic": false, "_links": { "self": { "href": "/v6/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad" }, "folders": { "href": "/v6/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/folders?parentId=null" }, "allfolders": { "href": "/v6/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/folders" }, "items": { "href": "/v6/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/items" } }, "_actions": { "restoreToOriginalLocation": { "uri": "v6/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/restore", "method": "POST" }, "restoreTo": { "uri": "v6/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/restoreTo", "method": "POST" }, "exporttoPst": { "uri": "v6/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/exporttoPst", "method": "POST" }, "search": { "uri": "v6/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/search", "method": "POST" } } } |