Overview
Exchange Connection Manager is SSIS Connection Manager for establishing Exchange connections. It is based on Microsoft Exchange Web Services Managed API. Use the API to build components based on Exchange Connection Manager.
NOTE: Going forward, to use the Exchange Connection, you will need to upgrade to SSIS+ 2.1.
Quick Start
In this task, we will show you step-by-step how to create a connection to Exchange Online.
Step 1. Right click Visual Studio to launch using "Run As Administrator".
Step 2. Right click on "Connection Managers" tab and select "New Connection..."
Step 3. In "Add SSIS Connection Manager" scroll down and select "Exchange" and click "Add..."
Step 4. To configure the Exchange Connection, choose Deployment type to "Online" and the Host is added as default. In the Token section for File/Id click the drop down and choose new to start the token generation wizard.
Step 5. During the token generation process you will see that client_id has a default client_id. The default client_id is an application registered by COZYROC and validated by Microsoft. The customer now has a choice for one of the following options below.
- The customer's Administrator will need to give the COZYROC application consent and then and only then can the customer proceed in the token generation wizard to give login consent to COZYROC's application.
- Setup your own client_id, instead of using the one proviced by COZYROC. This step needs to be done to create your own client_id to connect and to be used during the token generation. The following KB article will help you setup your own client_id:
How to setup your client id to connect with COZYROC Exchange Connector
Most customers are choosing option #2 as Microsoft has not made it clear how the customer is to give the permissions for the 1st option.
Step 6. Enter your credentials for Exchange and select Next.
Step 7. Create and Save your password protected Exchange Service token file. Click OK.
Step 8. Click "Test Connection" to test your connection.
Parameters
Server
Use the Server page of the Exchange Connection Manager dialog to specify parameters for connecting to Exchange mail service.
- Test Connection
- Confirm connection manager configuration by clicking Test Connection.
Specify to auto-discover host address from specified user name. This parameter has the options listed in the following table.
Value Description True Auto-discover host address (default). False Host address has to be explicitly specified. Specify Exchange deployment. This parameter has the options listed in the following table.
Value Description Premise On-premises server deployment. Online Online service deployment. Specify the name or IP address of the Exchange server.
Specify user name to access Exchange.
Specify password to access Exchange.
Specify entry Exchange mailbox. To specify sub-mailbox use backslash (\). Starting from 1.6 SR-4, the connection manager can connect to another user mailbox by specifying the email address of the user before the initial backslash.
Specify the number of seconds before timing out session connect. The default value of this parameter is 100 seconds.
Specify if all clients should use the same connection. This parameter has the options listed in the following table.
Value Description True All clients use same connection (default). False Every client use different connection. Specify the email address of the user to impersonate.
Not visible in the connection manager user interface.For online Exchange service, you must specify the connection token. The token storage can be file or SQL Server database. For SQL Server only an ADO.NET connection is supported. Database storage is introduced in version 2.1. An existing token can be selected from a file or a database storage. If a token doesn't exist, you must create a new token.
File/Id parameter displays the selected token file when existing token file is selected or a new token file is created. A file name can be manually entered. The parameter displays the selected database host name/IP and token id when a database token is selected or a new token is saved in a database.
In the parameter dropdown menu there are options to create a new token, browse for a token file and select a token from database. In the new token dialog the storage type can be selected - file or database.
Password specifies the token decryption password.
Proxy
Use the Proxy page of the Exchange Connection Manager dialog to specify properties if your server is behind firewall.
Specify the name or IP address of the proxy server. If not specified, proxy server is not used.
Specify the port number on the proxy server to use for the connection.
Specify user name to access the proxy server.
Specify password to access the proxy server.
Knowledge Base
- Where can I find the documentation for the Exchange Connection?
- How to connect to a Shared Mailbox?
- How to trace HTTP(S) and REST API using Fiddler
- Error Message: The connection type "xxxx" specified for connection manager "xxxx" is not recognized as a valid connection manager type. This error is returned when an attempt is made to create a connection manager for an unknown connection type. Check the spelling in the connection type name.
Related scripts
What's New
- Fixed: Failed with error "The API version 'V2' has been deprecated." on Test Connection.
- New: Implemented to create OAuth2 version 2.0 access tokens for Exchange Online.
- New: Store authentication token in a database.
- New: Support for Exchange Online token-based authentication.
- Fixed: Unable to set Mailbox parameter with expression (Thank you, Carl).
- New: Enabled support for TLS 1.1 and 1.2 protocols.
- New: A new parameter ImpersonatedUser.
- New: Support for opening of another user mailbox with delegated access.
- Fixed: Failed with error "Value cannot be null. Parameter name: uniqueId" when retrieving list of email (Thank you, Carsten).
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.