mailbox: exportItems

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Export Exchange mailboxItem objects in full fidelity. This API exports each item as an opaque stream. The data stream isn't intended for parsing, but can be used to import an item back into an Exchange mailbox. For more information, see: Overview of the mailbox import and export APIs in Microsoft Graph (preview)

You can export up to 20 items in a single export request.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	MailboxItem.ImportExport	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	MailboxItem.ImportExport.All	Not available.

HTTP request

POST /admin/exchange/mailboxes/{mailboxId}/exportItems

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the parameters.

The following table lists the parameters that are required when you call this action.

Parameter	Type	Description
itemIds	String collection	A collection of identifiers of mailboxItem objects to export. All identifiers in the collection must be for items in the same mailbox. Maximum size of this collection is 20 strings.

Response

If successful, this action returns a 200 OK response code and a collection of exportItemResponse objects in the response body.

Examples

Request

The following example exports two items present in the user's mailbox. The itemIds of the items to be exported are specified in the request body.

HTTP

POST https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/exportItems
Content-type: application/json

{
    "itemIds": [
        "EDSVrdi3lRAADmpnf1AAA=",
        "EDSVrdi3lRAAD45b7RAAA="
    ]
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Admin.Exchange.Mailboxes.Item.ExportItems;

var requestBody = new ExportItemsPostRequestBody
{
	ItemIds = new List<string>
	{
		"EDSVrdi3lRAADmpnf1AAA=",
		"EDSVrdi3lRAAD45b7RAAA=",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Admin.Exchange.Mailboxes["{mailbox-id}"].ExportItems.PostAsExportItemsPostResponseAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

mgc-beta admin exchange mailboxes export-items post --mailbox-id {mailbox-id} --body '{\
    "itemIds": [\
        "EDSVrdi3lRAADmpnf1AAA=",\
        "EDSVrdi3lRAAD45b7RAAA="\
    ]\
}\
'

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphadmin "github.com/microsoftgraph/msgraph-beta-sdk-go/admin"
	  //other-imports
)

requestBody := graphadmin.NewExportItemsPostRequestBody()
itemIds := []string {
	"EDSVrdi3lRAADmpnf1AAA=",
	"EDSVrdi3lRAAD45b7RAAA=",
}
requestBody.SetItemIds(itemIds)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
exportItems, err := graphClient.Admin().Exchange().Mailboxes().ByMailboxId("mailbox-id").ExportItems().PostAsExportItemsPostResponse(context.Background(), requestBody, nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.admin.exchange.mailboxes.item.exportitems.ExportItemsPostRequestBody exportItemsPostRequestBody = new com.microsoft.graph.beta.admin.exchange.mailboxes.item.exportitems.ExportItemsPostRequestBody();
LinkedList<String> itemIds = new LinkedList<String>();
itemIds.add("EDSVrdi3lRAADmpnf1AAA=");
itemIds.add("EDSVrdi3lRAAD45b7RAAA=");
exportItemsPostRequestBody.setItemIds(itemIds);
var result = graphClient.admin().exchange().mailboxes().byMailboxId("{mailbox-id}").exportItems().post(exportItemsPostRequestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const exportItemResponse = {
    itemIds: [
        'EDSVrdi3lRAADmpnf1AAA=',
        'EDSVrdi3lRAAD45b7RAAA='
    ]
};

await client.api('/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/exportItems')
	.version('beta')
	.post(exportItemResponse);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Admin\Exchange\Mailboxes\Item\ExportItems\ExportItemsPostRequestBody;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new ExportItemsPostRequestBody();
$requestBody->setItemIds(['EDSVrdi3lRAADmpnf1AAA=', 'EDSVrdi3lRAAD45b7RAAA=', 	]);

$result = $graphServiceClient->admin()->exchange()->mailboxes()->byMailboxId('mailbox-id')->exportItems()->post($requestBody)->wait();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.admin.exchange.mailboxes.item.export_items.export_items_post_request_body import ExportItemsPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ExportItemsPostRequestBody(
	item_ids = [
		"EDSVrdi3lRAADmpnf1AAA=",
		"EDSVrdi3lRAAD45b7RAAA=",
	],
)

result = await graph_client.admin.exchange.mailboxes.by_mailbox_id('mailbox-id').export_items.post(request_body)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 232

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.exportItemResponse)",
    "value": [
        {
            "itemId": "EDSVrdi3lRAADmpnf1AAA=",
            "changeKey": "CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAEu4C+G",
            "data": "VGhpcyBpcyBhIHRlc3QgZGF0YSB0aGF0IHdpbGwgYmUgY29udmVydGVkIHRvIGEgQmFzZTY0IHN0cmVhbQ=="
        },
        {
            "itemId": "EDSVrdi3lRAAD45b7RAAA=",
            "changeKey": "CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAD4pUax",
            "data": "VGhpcyBpcyBhIHRlc3QgZGF0YSB0aGF0IHdpbGwgYmUgY29udmVydGVkIHRvIGEgQmFzZTY0IHN0cmVhbQ=="
        }
    ]
}