Import Mailbox operation

The Import Mailbox process imports mailbox data from a .pst file to a mailbox.

Note

The Import 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 Import Request operation.

The following table describes the input parameters for Import Mailbox process.

Adapter request parameters for Import Mailbox process

Element

Definition

Required

<PSTFolderPath>

Specifies the path of the .pst file from which data will be imported

Yes

<AllContentKeywords>

Specifies the keywords of the content to include in the import

If the command finds a keyword that you specify in the message body, attachment content, or subject, it will import 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 import 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

<AttachmentFilenames>

Specifies the filter for attachments

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

No

<BadItemLimit>

Specifies the number of corrupted items in a .pst file to skip before the import operation fails

No

<ContentKeywords>

Specifies the keywords of the content to include in the import

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

No

<EndDate>

Specifies the end date for filtering content that will be imported to the target mailbox

Only items in the .pst file whose date is prior to or the same as the end date will be imported. 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 import

No

<GlobalCatalog>

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

No

<Identity>

Specifies the target mailbox object to which you want to import data

You can use one of the following values:

  • ADObjectID
  • Distinguished name (DN)
  • Legacy Exchange DN
  • GUID
  • Domain\Account name
  • User principal name (UPN)
  • E-mail address
  • Alias (If the Get-Mailbox command object is piped, this parameter is not required.)

No

<Locale>

Specifies the locale of messages to import

The command will import 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 the keywords of the content to include in the import

If the command finds a keyword that you specify in the recipient list, it will import those messages.

No

<ReportFile>

Specifies the path and file name for the XML report log

No

<SenderKeywords>

Specifies the keywords of the content to include in the import

If the command finds a keyword that you specify in the sender, it will import those messages

No

<StartDate>

Specifies the start date for filtering content that will be imported to the target mailbox

Only items in the .pst file whose date is later than the start date will be imported. 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 .pst file

No

Note:

  • To import data from a .pst file, you must run the *Import-Mailboxcmdlet from a 32-bit computer that has the following installed:
    • 32-bit version of the Exchange management tools
    • Microsoft Office Outlook 2003 Service Pack 2 (SP2) or later versions
  • To run the Import-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 target mailbox
Was this page helpful? Yes No Submitting... Thank you

Comments