Use the mailbox import and export APIs in Microsoft Graph (preview)
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.
The mailbox import and export APIs in Microsoft Graph allow your application to import and export contents from Exchange Online mailboxes. Mailbox contents can be accessed as a collection of folders and items in a consistent format, without the need to manage the metadata or structure of each item type individually. These items can be exported in FastTransfer stream format with full fidelity. Full-fidelity exports ensure that when you import an item, Exchange recreates it with no loss of information.
These APIs support access to data in users' primary and in-place archive mailboxes on Exchange.
How to use the mailbox import and export APIs
The following steps allow your app to systematically export and import contents from Exchange mailboxes:
- Get a list of mailboxes that belong to a particular user.
- Discover the contents of the mailbox as a set of folders and items.
- Export items from a mailbox.
- Create or update mailbox folders.
- Import an item into the same or a different mailbox.
Common use cases
| Use case | REST resource | See also |
|---|---|---|
| Create, get, update, or delete a mailbox folder | mailboxFolder | mailboxFolder methods |
| Get one or more mailbox items | mailboxItem | mailboxItem methods |
| Get delta for folders | mailboxFolder mailboxFolder: delta | |
| Get delta for items | mailboxItem | mailboxItem: delta |
| Import or export mailboxes | mailbox | mailbox methods |
| Get a list of mailboxes that belong to a user | exchangeSettings | List Exchange settings |
Next steps
Use the mailbox import and export APIs in Microsoft Graph to import and export contents from Exchange mailboxes. To learn more:
- Explore the resources and methods that are most helpful to your scenario.
- Try the API in the Graph Explorer.
Related content
Import an Exchange mailbox item using the mailbox import and export APIs