Use this cmdlet to create a new connection object that describes the source and target stores and the store types to be used in a sync task. The returned object is a required value for New-SyncTask.
PowerShell
New-ConnectionInfo
- -SourceType
- -TargetType
- -SourceSmtp
- -SourceServer
- -SourceCreds
- -TargetSmtp
- -TargetServer
- -TargetCreds
- -SourcePstFile
- -SourcePstPassword
- -TargetPstFile
- -TargetPstPassword
Description
The New-ConnectionInfo cmdlet is used to create an object that contains details about how Super-ExMerge connects to a source and target store.
This cmdlet uses Dynamic Parameters that change based on the SourceType and TargetType parameters. The *PstFile and *PstPassword parameters only appear when the source or target type is PST. The *Smtp, *Server, and *Creds parameters appear for the Mailbox, Archive, and PublicFolder types.
Super-ExMerge uses AutoDiscover when possible in order to properly build a MAPI profile for its use. Any email address that exists on a mailbox can be used, which may or may not be the primary SMTP address. For environments where AutoDiscover does not exist (Exchange 2003) or is not configured or is unreachable, Super-ExMerge will attempt to use a legacy mechanism to configure a profile, however this is only used if the AutoDiscover attempt fails. Furthermore, if the legacy method is used, the resulting profile can only work on Exchange 2010 and earlier since profiles created this way do not support HTTP connections.
When using PST files, Super-ExMerge does not have the ability to span data across multiple files. The default implementation creates Unicode PST files, which (by default) have a 20-30gb limit on size. This size is changeable via the registry, but is also dependent upon the version of Outlook that is installed on the host. Super-ExMerge will copy data into a PST file until it fills up, at which point all subsequent items will simply fail to be copied.
Super-ExMerge support the following store types: Archive Mailboxes, Mailboxes, Public Folders, and PST files.
The following connection patterns are supported:
- Mailbox to Mailbox
- Mailbox to Archive Mailbox
- Mailbox to Public Folders
- Mailbox to PST File
- Archive Mailbox to Mailbox
- Archive Mailbox to Public Folders
- Archive Mailbox to PST File
- Archive Mailbox to Archive Mailbox
- Public Folders to Mailbox
- Public Folders to Archive Mailbox
- Public Folders to Public Folders
- Public Folders to PST File
- PST File to Mailbox
- PST File to Archive Mailbox
- PST File to Public Folders
Note that PST-to-PST is not supported as it is unnecessary.
A mailbox, in the context of Super-ExMerge, is any Microsoft Exchange mailbox for which a MAPI connection can be made. Namely, this includes User Mailboxes, Linked Mailboxes, Shared Mailboxes, Equipment Mailboxes, Room Mailboxes. If a mailbox has had its MAPI connection type disabled in Microsoft Exchange, Super-ExMerge will not be able to connect to it, even if AutoDiscover returns information.
And of special note, an Office 365 mailbox created by a K1 license type cannot be used because the license does not allow MAPI connections. Please review Office 365 license types with regards to which types support MAPI.
Examples
Example 1
PowerShell
New-ConnectionInfo -SourceType Mailbox -TargetType Mailbox -SourceSmtp user@source.com -SourceServer autodiscover.source.com -SourceCreds 'user@source.com:Passw0rd' -TargetSmtp user@target.com -TargetServer autodiscover.target.com -TargetCreds 'user@target.com:Passw0rd'
This example creates a mailbox-to-mailbox connection.
Example 2
PowerShell
New-ConnectionInfo -SourceType Mailbox -TargetType Archive -SourceSmtp user@source.com -SourceServer autodiscover.source.com -SourceCreds 'Cached:SourceMapi' -TargetSmtp user@target.com -TargetServer autodiscover.target.com -TargetCreds 'user@target.com:HostKey#AaDajuibjhuw88902389vgnv=='
This example creates a mailbox-to-archive connection. This example also shows alternate forms of the *Creds parameters with the source using a cached credential from the Priasoft credential cache and target using an encrypted password that was encrypted using the local host’s HostKey. For more detail, review the New-FormattedCredential cmdlet.
Example 3
PowerShell
New-ConnectionInfo -SourceType PublicFolder -TargetType Archive -SourceSmtp user@source.com -SourceServer autodiscover.source.com -SourceCreds 'SourceDom\admin:B64=jiff4889na890fhjedf=' -TargetSmtp user@target.com -TargetServer autodiscover.target.com -TargetCreds 'user@target.com:PSK=juf108734hfvoziuhvg087hr==#88jvunvuin978nekunoyi=='
This example creates a publicfolder-to-archive connection. This example shows an alternate use of the *Creds parameter values. The source credential uses a DOM\username pattern for the username and a simple Base64 encoded version of the password. The target credential uses a password that was encrypted with a pre-shared key.
Example 4
PowerShell
New-ConnectionInfo -SourceType PublicFolder -TargetType PST -SourceSmtp user@source.com -SourceServer autodiscover.source.com -SourceCreds 'SourceDom\admin:Password' -TargetPSTFile c:\path\to\folder\file.name.pst
This example creates a publicfolder-to-pst connection.
Parameters
-SourceType
The SourceType parameter specifies the type of store to which Super-ExMerge should connect. Currently available types are: Archive, Mailbox, PublicFolder, and PST.
-TargetType
The TargetType parameter specifies the type of store to which Super-ExMerge should connect. Currently available types are: Archive, Mailbox, PublicFolder, and PST.
-SourceSmtp
The SourceSmtp parameter is only available when the SourceType parameter value is Archive, Mailbox, or PublicFolder.
This parameter specifies the SMTP address of a mailbox to which to connect. Any SMTP address available on the mailbox can be used.
When the SourceType is PublicFolder, this parameter must point at a mailbox that is configured to access public folders. In Exchange 2010 and earlier, access to a specific public folder database is determined by a setting on the mailbox database of the connected mailbox. In Exchange 2013 and later, including Office 365, individual mailboxes can be configured to have no access to public folders, while other mailboxes do.
Furthermore, if credential provided in SourceCreds does not have sufficient privilege, Super-ExMerge may not be able to open the public folder store, or may not have access to all folders. It is recommended, for on-premises deployments, to use a credential that has system privileges that at a database level. For Office 365 it is recommended that the SourceCreds credential have Owner rights on all folders.
-SourceServer
The SourceServer parameter specifies the Microsoft Exchange server that has a supporting CAS role and can be used for AutoDiscover requests. Note that AutoDiscover requests are only supported via a secure connection (HTTPS) which inherently requires that the server name provided can be validated on the server certificate of the Exchange server used. If using the explicit name of an Exchange server, validate that the server’s name is either the subject of the certificate, is listed as one of the Subject Alternative Names (SAN), or matches a wildcard value of either the subject or SAN list.
-SourceCreds
The SourceCreds parameter specifies the credential to use to authenticate to the mailbox provided in SourceSmtp. Super-ExMerge supports the use of a special format for string-based credentials that allow for securing the password in several ways which facilitates the embedding of credentials in scripts, databases, and etc.
Note that the SourceCreds is not required to be the same account as the mailbox to which the connection is defined. Microsoft Exchange supports accessing mailboxes as an account other than the owner through the use of the FullAccess permission and via mailbox database permissions.
Priasoft does not use impersonation to access mailboxes and is therefore not limited in the way that other connection patterns may use.
