|
Parameter
|
Required
|
Type
|
Description
|
|---|
|
Identity
|
Required
|
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter
|
The Identity parameter 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.
|
|
PSTFolderPath
|
Required
|
Microsoft.Exchange.Data.LongPath
|
The PSTFolderPath parameter specifies the path of the .pst file to which data will be exported.
|
|
TargetFolder
|
Required
|
System.String
|
The TargetFolder parameter 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.
|
|
TargetMailbox
|
Required
|
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter
|
The TargetMailbox parameter specifies the mailbox where the target folder will be created. The mailbox that you specify must exist for the command to complete successfully.
|
|
AllContentKeywords
|
Optional
|
System.String[]
|
The AllContentKeywords parameter 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.
Note:
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.
|
|
AllowDuplicates
|
Optional
|
System.Management.Automation.SwitchParameter
|
The AllowDuplicates parameter is used to copy mail items without checking if they are duplicates of existing items and without removing duplicate items. We recommend that you use the AllowDuplicates parameter together with the IncludeFolders parameter.
|
|
AllowMerge
|
Optional
|
System.Management.Automation.SwitchParameter
|
The AllowMerge parameter 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.
|
|
AttachmentFilenames
|
Optional
|
System.String[]
|
The AttachmentFilenames parameter 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.
|
|
BadItemLimit
|
Optional
|
System.Int32
|
The BadItemLimit parameter specifies the number of corrupted items in a mailbox to skip before the export operation fails.
|
|
Confirm
|
Optional
|
System.Management.Automation.SwitchParameter
|
The Confirm parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter.
|
|
ContentKeywords
|
Optional
|
System.String[]
|
The ContentKeywords parameter 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.
|
|
DeleteAssociatedMessages
|
Optional
|
System.Management.Automation.SwitchParameter
|
The DeleteAssociatedMessages parameter 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.
|
|
DeleteContent
|
Optional
|
System.Management.Automation.SwitchParameter
|
The DeleteContent parameter 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.
|
|
EndDate
|
Optional
|
System.DateTime
|
The EndDate parameter 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.
|
|
ExcludeFolders
|
Optional
|
Microsoft.Exchange.Data.Mapi.MapiFolderPath[]
|
The ExcludeFolders parameter specifies the list of folders to exclude during the export.
|
|
GlobalCatalog
|
Optional
|
Microsoft.Exchange.Data.Fqdn
|
The GlobalCatalog parameter specifies the global catalog to use to search for the target mailbox.
|
|
IncludeAssociatedMessages
|
Optional
|
System.Management.Automation.SwitchParameter
|
The IncludeAssociatedMessages parameter 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.
|
|
IncludeFolders
|
Optional
|
Microsoft.Exchange.Data.Mapi.MapiFolderPath[]
|
The IncludeFolders parameter specifies the list of folders to include during the export.
|
|
Locale
|
Optional
|
System.Globalization.CultureInfo
|
The Locale parameter specifies the locale of messages to export. The command will export only messages with the locale that you specify.
|
|
MaxThreads
|
Optional
|
System.Int32
|
The MaxThreads parameter specifies the maximum number of threads to use. The default value is 4.
|
|
RecipientKeywords
|
Optional
|
System.String[]
|
The RecipientKeywords parameter 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.
|
|
ReportFile
|
Optional
|
Microsoft.Exchange.Data.LocalLongFullPath
|
The ReportFile parameter specifies the path and file name for the XML report log.
|
|
SenderKeywords
|
Optional
|
System.String[]
|
The SenderKeywords parameter 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.
|
|
StartDate
|
Optional
|
System.DateTime
|
The StartDate parameter 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.
|
|
SubjectKeywords
|
Optional
|
System.String[]
|
The SubjectKeywords parameter specifies the keyword filters for subjects of items in the source mailbox.
|
|
ValidateOnly
|
Optional
|
System.Management.Automation.SwitchParameter
|
The ValidateOnly parameter provides the option to validate the export without exporting the data. The ValidateOnly parameter validates any prerequisites for the command.
Note:
If you run the Export-Mailbox command with this parameter, the command will not apply any filters to the messages. It will only check if the source and target mailboxes exist.
|
|
WhatIf
|
Optional
|
System.Management.Automation.SwitchParameter
|
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You do not have to specify a value with the WhatIf parameter.
|