Overview
IMAP Connection Manager is SSIS Connection Manager for establishing connections with IMAP-enabled mail servers. Use the API to build components based on IMAP Connection Manager.
Parameters
Server
Use the Server page of the IMAP Connection Manager dialog to specify properties for connecting to IMAP mail server.
- Test Connection
- Confirm connection manager configuration by clicking Test Connection.
Specify connection type. This property has the options listed in the following table.
Value Description Unsecure Unsecured IMAP connection. ExplicitSSL Use Explicit SSL IMAP. ImplicitSSL Use Implicit SSL IMAP. ExplicitTLS Use Explicit TLS IMAP. ImplicitTLS Use Implicit TLS IMAP. Specify the name or IP address of the IMAP server.
Specify the port number on the IMAP server to use for the connection. The default value of this property is 143.
Specify user name to access IMAP mail server.
Specify password to access IMAP mail server.
Specify entry IMAP mailbox.
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. For Google and Microsoft OAuth 2.0 authentication, you must specify the connection token. The token storage can be a file or an SQL Server database. For SQL Server only an ADO.NET connection is supported. 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.
Advanced
Use the Advanced page of the IMAP Connection Manager dialog to to specify additional properties if your server configuration is different from the default.
Specify authentication algorithm. This property has the options listed in the following table.
Value Description Auto Automatically determines and uses the most secure available method. Plain Uses TLS plain text authentication. DigestMD5 Uses DIGEST-MD5 authentication. CramMD5 Uses CRAM-MD5 authentication. Login Uses login authentication. ClearText Uses clear text USER/PASS authentication. Ntlm Uses NTLM authentication. External Uses external authentication. GssApi Uses GSSAPI/SSPI authentication. GoogleOAuth2 Uses OAuth 2.0 token authentication. Use this information to setup Connection Type, Host and Port. 2.1 MicrosoftOAuth2 Uses OAuth 2.0 (a.k.a "modern") token authentication. 2.1 Specify verbose log file name for investigating IMAP connection issues.
Proxy
Use the Proxy page of the IMAP 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 IMAP Connection?
- Does COZYROC support TLS 1.1 and 1.2 protocols?
- 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
- New: Support for Google OAuth 2.0 authentication.
- New: Support for Microsoft OAuth 2.0 authentication.
- New: Support for TLS 1.3.
- New: Support for TLS 1.1 and 1.2.
- New: New API methods.
- 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.