Overview
These public interfaces are used in Exchange components. They are provided for implementing advanced functionality in your scripts. In order for you to use these interfaces in your project, you have to reference CozyRoc.SSISPlus.dll and Microsoft.Exchange.WebServices.dll libraries. Also include CozyRoc.SqlServer.SSIS and optionally Microsoft.Exchange.WebServices.Data namespaces.
IExchangeConnection
When you call Exchange Connection Manager AcquireConnection method, it returns object implementing IExchangeConnection interface. This is the interface used for interaction with Exchange mail server.
Methods
Connects to Exchange mail server. The result is IMailClient object.
Closes the connection to an Exchange mail server. Use always after you finish working with the server. You may also dispose the returned object from Connect method as alternative.
Returns true if connected to the server.
Returns underlying Exchange service object.
Copies mail to destination folder. These are the method parameters:
- mi (IMailInfo) - mail information object.
- destinationFolder (string) - destination folder.
Creates mail folder. These are the method parameters:
- folder (string) - folder name.
Deletes mail folder. These are the method parameters:
- folder (string) - folder name.
Gets list of mail folders. These are the method parameters:
- parent (string) - parent folder for which to retrieve list of folders. Set to empty to get list of root folders.
Properties
Specify to auto-discover host address from specified user name. This property 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 property has the options listed in the following table.
Value | Description |
---|---|
0 | On-premises server deployment. |
1 | Online service deployment. |
Specify the name or IP address of the Exchange mail server.
Specify user name to access the Exchange mail server.
Specify user password to access the Exchange mail server.
Specify entry Exchange mailbox. To specify sub-mailbox use backslash (\).
Specify the number of seconds before timing out session connect. The default value of this property is 100 seconds.
Specify if all clients should use the same connection. This property 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 name or IP address of the proxy server.
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.
Specify token storage. This property has the options listed in the following table.
Value | Description |
---|---|
File | Token is stored in a file. |
Database | Token is stored in a database. |
This is a complementary property to TokenStoreType property. Depending on the store type, the property will contain the following information:
TokenStoreType | Information |
---|---|
File | File path to token file. |
Database | Complete connection string to the database where token is stored. |
Knowledge Base
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.