Saving Mailbox Items
You can save backed-up items to MSG files (Outlook Message Files).
When you save backed-up items, the request command saves the items to MSG files and transfers them to application/octet-stream media. You can use Swagger UI to download the mailbox items in the MSG format from the stream by clicking the Download action link in the response body. For more information, see Evaluation in Swagger UI.
Request
POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/save |
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
To save backed-up organization mailbox items to MSG files, the request body must contain the following property:
Property | Type | Description |
|---|---|---|
items | item[] | Specifies the IDs of mailbox items that you want to save to MSG files. For more information on how to get such IDs, see Getting Mailbox Items. |
For example:
Request Body: { "items": [ {"Id": "74685f6b-16aa-4a78-a44f-05526ce0ae30"}, {"Id": "70013a9e-c446-429d-aa78-9c8c20d9b814"} ] } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns 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 for the requests with the export and save actions: application/octet-stream. The media type and syntax of the response body message for the requests with the restore and send actions: null. |
Response Body
In the response body, the server returns binary data stream.
Example
The following request saves backed-up mailbox items with the specified IDs to MSG files.
Request: POST https://abc.tech.local:4443/v6/RestoreSessions/380d7caf-6294-4a33-b50a-b8aeb13af58c/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/Items/save
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "items": [ {"Id": "74685f6b-16aa-4a78-a44f-05526ce0ae30"}, {"Id": "70013a9e-c446-429d-aa78-9c8c20d9b814"} ] }
Response: 200 OK |