Use the Get-ImapMailboxData cmdlet to create a Transporter object from an IMAP mailbox or a group of IMAP mailboxes.

Get-ImapMailboxData -SourceLoginID <String> [-SourcePassword <String>] [-SourceRootFolder <String>] -SourceIdentity <String> [-SourcePort <UInt32>] [-EmailEnd <DateTime>] [-TargetIdentity <String>] [-Quiet] [-EmailStart <DateTime>] [-FolderMapFile <String>] [-SourceAdminCredential <PSCredential>] [-AllowUnsecureConnection]

Get-ImapMailboxData -TransporterObject <Microsoft.Exchange.Transporter.IAlienDataObject> [-SourceServer <String>] [-EmailEnd <DateTime>] [-TargetIdentity <String>] [-Quiet] [-EmailStart <DateTime>] [-FolderMapFile <String>] [-SourceAdminCredential <PSCredential>] [-AllowUnsecureConnection]

Parameters

Parameter Required Type Description

SourceLoginID

Required

System.String

The user logon ID of an individual source IMAP mailbox.

SourcePassword

Required

System.String

The password for the user logon ID that is used in the SourceLoginID parameter.

SourceRootFolder

Optional

System.String

Used to indicate the root of an IMAP mailbox.

SourceIdentity

Required

System.String

Unique SMTP e-mail address that is used to identify the mailbox that is being moved and to match it with an existing Microsoft Exchange Server 2007 mailbox.

SourcePort

Optional

System.UInt32

The port that is used to connect to the source IMAP server.

TransporterObject

Required

Microsoft.Exchange.Transporter.IAlienDataObject

Used to pass in Transporter objects from the Get-ImapMailbox task through the Windows PowerShell pipeline.

SourceServer

Required

System.String

The IMAP server to extract mailbox content from.

EmailEnd

Optional

System.DateTime

Used to specify the end date in a date range to filter mailbox content based on date.

TargetIdentity

Optional

System.String

The SMTP address that is used to indicate a specific Exchange mailbox to inject mailbox content into. If this parameter is not set, the SourceIdentity parameter is used to match the mailbox that is being migrated with an existing Exchange mailbox.

Quiet

Optional

System.Management.Automation.SwitchParameter

Suppresses feedback during task actions.

EmailStart

Optional

System.DateTime

Used to specify the start date in a date range to filter mailbox content based on date.

FolderMapFile

Optional

System.String

The file that contains the mapping information of IMAP folders to Exchange folders.

SourceAdminCredential

Optional

System.Management.Automation.PSCredential

The PowerShell credential object that contains a user name and password.

AllowUnsecureConnection

Optional

System.Management.Automation.SwitchParameter

Allows the task to connect to the source server over a non-Secure Sockets Layer (SSL) port to extract mail from an IMAP mailbox.

Detailed Description

The Get-ImapMailboxData cmdlet extracts content from existing IMAP mailboxes into a Transporter object. Folder structure, e-mail, MIME information, and rich content are preserved when the Transporter object is created.

Transporter objects that are created by using the Get-ImapMailboxData cmdlet can be saved as pipeline objects and moved to a computer that is running Exchange 2007 by using the Add-ExchangeItem cmdlet.

To create a Transporter object by using the Get-ImapMailboxData cmdlet, you must have Full Access permissions to the IMAP mailboxes that you are migrating. To retrieve mailbox data from an IMAP server, you can use either individual credentials for each mailbox that you want to retrieve, or Administrator credentials to access all mailboxes. For more information, see Source Server Permissions.

Input Types

None.

Return Types

Transporter Object

Example

The following example shows you how to use the Get-ImapMailboxData cmdlet to retrieve a single mailbox by using a unique logon ID and password.

The following example shows you how to save a Transporter object that was created by using the Get-ImapMailboxData cmdlet as a pipeline object and move it to an Exchange server by using the Add-ExchangeItem cmdlet.

See Also