Restoring Mailbox Items to Another Mailbox
You can restore backed-up items to another mailbox.
Request
POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/restoreTo |
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 restore backed-up items to a different mailbox on the production server, the request body must contain the following properties:
Property | Type | Description |
|---|---|---|
mailbox | string | Specifies the email address of the mailbox to which you want to restore mailbox items. |
items | item[] | Specifies the IDs of mailbox items that you want to restore. For more information on how to get such IDs, see Getting Mailbox Items. |
userName | string | Specifies the user name that you want to use for authenticating to the Exchange organization. |
userPassword | string | Specifies the password of the user account that you want to use for authenticating to the Exchange organization. |
userCode | string | Specifies the authentication code. For more information on how to get a device code, see Getting Device Code. This property is required if you want to use a device code for data restore. |
casServer | string | Specifies the Microsoft Exchange server with Client Access Server (CAS) role. The mailbox items will be restored to a specified mailbox server. |
folder | string | Specifies the folder to which you want to restore mailbox items. |
changedItems | boolean | If set to true, indicates that all versions of mailbox items will be restored. |
deletedItems | boolean | If set to true, indicates that deleted mailbox items will be restored. |
markrestoredAsunread | boolean | If set to true, indicates that restored mailbox items will be marked as unread. |
applicationId | string | An identification number of the Azure AD application that you want to use for a restore. |
applicationCertificate | base64 | Specifies the SSL certificate configured for the Azure AD application that you want to use for data restore. You must provide the certificate as a Base64 string. For more information on how to obtain a Base64 string, see Converting Certificate to Base64 String. |
applicationCertificatePassword | string | A password for the SSL certificate being used. |
impersonationAccountName | string | Specifies a user name of the account that will be used as a Microsoft Exchange account to restore backed-up mailbox items. This property is required if you want to use an application certificate for data restore. Use this property only with the applicationCertificate property. |
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 information about operation results.
The response body for the restore operation contains the following properties:
Property | Type | Description |
|---|---|---|
createdItemsCount | integer | Number of missing items restored from the backup. |
mergedItemsCount | integer | Number of changed items restored from the backup. |
failedItemsCount | integer | Number of items for which the restore operation failed. |
skippedItemsCount | integer | Number of items that were not changed or missing in the original location. Such items are skipped during the restore operation. |
Example
The following request restores all backed-up mailbox items to a different mailbox on the production Exchange server.
Request: POST https://abc.tech.local:4443/v6/RestoreSessions/380d7caf-6294-4a33-b50a-b8aeb13af58c/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/Items/restoreTo
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "userPassword": "Pa$$w0rd", "userName": "administrator@westsupport.onmicrosoft.com", "mailbox": "djohnes@westsupport.onmicrosoft.com", "casServer": "outlook.office365.com", "folder": "Folder1", "changedItems": true, "deletedItems": false, "markrestoredAsunread": true }
Response: 200 OK
Response Body: { "createdItemsCount": 3, "mergedItemsCount": 2, "failedItemsCount": 0, "skippedItemsCount": 1 } |