Export Mailbox operation

The Export Mailbox process moves the contents of a mailbox to a specified mailbox folder.

Note

The Export Mailbox operation is only supported on Microsoft Exchange Server version 2007 and version 2010 (RTM only). For later versions such as Microsoft Exchange Server version 2013 and 2016, consider using the New Mailbox Export Request operation.

The following table describes the input parameters for Export Mailbox process:

 Adapter request parameters for Export Mailbox process 

Element

Definition

Required

<Identity>

Specifies the mailbox from which to export contents 

You can use the following values:

  • Alias
  • Simple Mail Transfer Protocol (SMTP) address
  • Display name (If the Get-Mailbox command object is piped, this parameter is not required.)

Yes

<PSTFolderPath>

Specifies the path of the .pst file to which data will be exported

Yes

<TargetFolder>

Specifies the top-level mailbox folder that will be created on the mailbox specified by the TargetMailbox parameter 

This folder will contain a subfolder called Recovered Data -<source mailbox alias> - <date time stamp>. The subfolder contains the exported data. If the target folder that you specify already exists on the target mailbox, the exported data will be added to the existing folder. If the target folder does not exist, it will be created.

Yes

<TargetMailbox>

Specifies the mailbox where the target folder will be created 

The mailbox that you specify must exist for the command to complete successfully.

Yes

<AllContentKeywords>

Specifies the keywords of the content to include in the move 

If the command finds a keyword that you specify in the message body, attachment content, or subject, it will export those messages. 

This is different from using both the ContentKeywords and SubjectKeywords parameters. If you use both the ContentKeywords and SubjectKeywords parameters, the command will export only those messages that have both the keyword that you specify for the ContentKeywords parameter in the message body or attachment content, and the keyword you specify for the SubjectKeywords parameter in the subject.

No

<AllowMerge>

Specifies that the content that is exported will be merged into the target folder to avoid duplicates 

If you specify the AllowMerge parameter, the name of the subfolder to which content is exported will not include a date-time stamp. You can export data to the same target folder and subfolder multiple times by using the AllowMerge parameter.

No

<AttachmentFilenames>

Specifies the filter for attachments 

You can use wildcard characters in the string. For example, you can use "*.txt" to export items that have a .txt extension.

No

<BadItemLimit>

Specifies the number of corrupted items in a mailbox to skip before the export operation fails

No

<ContentKeywords>

Specifies the keywords of the content to include in the move 

If the command finds a keyword that you specify in the message body or in the attachment content, it will export those messages.

No

<DeleteAssociatedMessages>

Specifies that associated messages will be deleted 

Associated messages contain hidden data with information about rules, views, and forms. If you use the DeleteAssociatedMessages parameter and do not specify a TargetMailbox and TargetFolder, or a PSTFolderPath, no content will be exported.

No

<DeleteContent>

Specifies the option to delete the content from the source mailbox after it has been exported to a folder. The source folder will not be deleted.

No

<EndDate>

Specifies the end date for filtering content that will be exported from the source mailbox 

Only items in the mailbox whose date is prior to or the same as the end date will be exported. When you enter a specific date, use the short date format that is defined in the Regional Options settings that are configured on the local computer. For example, if your computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2006 to specify March 1, 2006.

No

<ExcludeFolders>

Specifies the list of folders to exclude during the export

No

<GlobalCatalog>

Specifies the global catalog to use to search for the target mailbox

No

<IncludeAssociatedMessages>

Specifies that associated messages will be included in the export

Associated messages contain hidden data with information about rules, views, and forms. By default, associated messages are not included in an export.

No

<IncludeFolders>

Specifies the list of folders to include during the export

No

<Locale>

Specifies the locale of messages to export 

The command will export only messages with the locale that you specify.

No

<MaxThreads>

Specifies the maximum number of threads to use 

The default value is 4.

No

<RecipientKeywords>

Specifies recipient e-mail addresses or display names 

If the command finds a message with a recipient that is the same as the recipient keyword that you specified, it will export the message. 

If the recipient keyword that you specify is the same as a distribution group that is a recipient of a message, the message will be exported. The command does not expand distribution groups to compare the recipient keywords that you specify to the members of a distribution group that is a recipient of a message.

No

<ReportFile>

Specifies the path and file name for the XML report log

No

<SenderKeywords>

Specifies sender e-mail addresses or display names 

If the command finds a message with a sender that is the same as a sender keyword that you specify, it will export the message.

No

<StartDate>

Specifies the start date for filtering content that will be exported from the source mailbox 

Only items in the mailbox whose date is later than the start date will be exported. When you enter a specific date, use the short date format that is defined in the Regional Options settings that are configured on the local computer. For example, if your computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2006 to specify March 1, 2006.

No

<SubjectKeywords>

Specifies the keyword filters for subjects of items in the source mailbox

No

   

Note

To run the Export-Mailbox cmdlet, the account you use must be delegated the following:

  • Exchange Server Administrator role and local Administrators group for the target server
  • Full access to the source and target mailboxes 

    To grant full access to a mailbox, use the Add-MailboxPermissioncmdlet and specify FullAccess for the AccessRights parameter. 

    You cannot export data from a mailbox in one forest to a mailbox in a different forest. The source and target mailboxes must be in the same forest. 

    You can use the Export-Mailbox cmdlet to export data to either a folder or a .pst file. The source and target mailboxes must be on one of the following:
  • Exchange 2007 server
  • Exchange Server 2003 Service Pack 2 (SP2) (or later versions) server
  • Exchange 2000 Server Service Pack 3 (SP3) (or later versions) server To export data from a .pst file, you must run the Export-Mailboxcmdlet from a 32-bit computer that has the following installed:
  • The 32-bit version of the Exchange management tools
  • Microsoft Office Outlook 2003 SP2 or later versions
Was this page helpful? Yes No Submitting... Thank you

Comments