Restoring Mailbox Items to Another Mailbox

In this article

    You can restore a backed-up item with the specified ID to another mailbox.

    Request

    POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}/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.

    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

    To restore a backed-up item to a different mailbox on the production Exchange 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 a mailbox item.

    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. A mailbox item will be restored to a specified mailbox server.

    folder

    string

    Specifies the folder to which you want to restore a mailbox item.

    officeRegion

    string

    Specifies the region of the target Exchange organization. The following values are available:

    • Worldwide
    • USGovernment
    • Germany
    • China
    • USDefence

    officeOrganizationName

    string

    Specifies the name of the target Exchange organization.

    changedItems

    boolean

    If set to true, indicates that all versions of a mailbox item will be restored.

    deletedItems

    boolean

    If set to true, indicates that deleted mailbox item will be restored.

    markRestoredAsUnread

    boolean

    If set to true, indicates that restored mailbox item will be marked as unread.

    excludeDrafts

    boolean

    If set to true, indicates that Drafts mailbox folder will not be restored.

    Example: "excludeDrafts": false.

    excludeDeletedItems

    boolean

    If set to true, indicates that Deleted Items mailbox folder will not be restored.

    Example: "excludeDeletedItems": false.

    excludeInPlaceHoldItems

    boolean

    If set to true, indicates that preserved items of mailboxes placed on In-Place Hold will not be restored.

    Example: "excludeInPlaceHoldItems": true.

    excludeLitigationHoldItems

    boolean

    If set to true, indicates that preserved items of mailboxes placed on Litigation Hold will not be restored.

    Example: "excludeLitigationHoldItems": true.

    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 a specific backed-up mailbox item.

    This property is required if you want to use an application certificate for data restore. Use this property only with the applicationCertificate property.

    Converting Certificate to Base64 String

    If you want to use a certificate to access an Azure AD application, you must provide the certificate as a Base64 string. To obtain a Base64 string, perform the following steps:

    1. Get the certificate content from a PFX file.
    2. Convert the certificate to a Base64 string.

    To do this, you can use the following PowerShell cmdlets:

    $pfx_cert = get-content '<path_to_cert>' -Encoding Byte

    [System.Convert]::ToBase64String($pfx_cert) | Out-File '<path_to_file>'

    where:

    For example:

    $pfx_cert = get-content 'C:\cert.pfx' -Encoding Byte

    [System.Convert]::ToBase64String($pfx_cert) | Out-File 'C:\base64.txt'

    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 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 example shows how to restore a backed-up item 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/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/restoreTo

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

       "mailbox": "djohnes@westsupport.onmicrosoft.com",

       "userName": "djohnes@westsupport.onmicrosoft.com",

       "userPassword": "paSSw0rd",

       "casServer": "outlook.office365.com",

       "folder": "Folder1",

       "changedItems": false,

       "deletedItems": false,

       "markRestoredAsUnread": true

    }

     

    Response:

    200 OK

     

    Response Body:

    {

     "createdItemsCount": 0,

     "mergedItemsCount": 0,

     "failedItemsCount": 0,

     "skippedItemsCount": 0

    }