Exporting Mailbox Items

In this article

    You can export a backed-up item with the specified ID to a PST file.

    Exporting Mailbox Items Important

    To export data to PST (Personal Storage Table) files, you must have a 64-bit version of Microsoft Outlook 2016, Microsoft Outlook 2013 or Microsoft Outlook 2010 installed on the computer running restore sessions.

    Request

    POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}/exportToPst

    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 export a backed-up item from the organization mailbox to a PST file, the request body must contain the following properties:

    Property

    Type

    Description

    enablePstSizeLimit

    boolean

    Defines whether to set the size limit for the exported PST file.

    If set to true, indicates that you must specify the pstSizeLimitBytes parameter.

    pstSizeLimitBytes

    integer

    Specifies the limit of the exported PST file in Bytes.

    You can choose the limit range from 1 GB to 49 GB.

    For example:

    Request Body:

    {

       "enablePstSizeLimit": false

    }

    The request command will export a backed-up item to a PST file and place it to a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the PST file will be transferred as application/octet-stream media to the client. To download, read, convert to PST or perform other actions with the octet-stream, use features of programming languages.

    Exporting Mailbox Items Tip

    You can use Swagger UI to download the octet-stream file by clicking the Download action link, which server returns in the response body after a successfully completed export operation. For more information, see Evaluation in Swagger UI.

    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 export a backed-up item to a PST file.

    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==/exportToPst

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

       "enablePstSizeLimit": false

    }

     

    Response:

    200 OK