Saving Mailbox Items

You can save a backed-up item with the specified ID to a file in the MSG format (Outlook Message File).

When you save a backed-up item, the request command saves the item to a file in the MSG format and transfers it to application/octet-stream media.

Saving Mailbox Items Tip

You can use Swagger UI to download the mailbox item 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/{itemId}/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.

itemId

string

Specifies the identification number of the mailbox item. For more information on how to get this parameter, see Getting Mailbox Items.

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 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 example shows how to save a backed-up item to a file in the MSG format.

Request:

POST https://abc.tech.local:4443/v6/RestoreSessions/380d7caf-6294-4a33-b50a-b8aeb13af58c/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/save

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

None

 

Response:

200 OK