IMAP API

Overview

These public interfaces are used in IMAP 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.

IImapConnection

When you call IMAP Connection Manager AcquireConnection method, it returns object implementing IImapConnection interface. This is the interface used for interaction with IMAP mail server.

Connect method

Connects to IMAP mail server. The result is IMailClient object.

Close method

Closes the connection to an IMAP mail Server. Use always after you finish working with the server. You may also dispose the returned object from Connect method as alternative.

IsConnected method

Returns true if connected to the server.

DeleteMail method (1.5 SR-2)

Deletes mail. These are the method parameters:

CopyMail method (1.5 SR-2)

Copies mail to destination folder. These are the method parameters:

  • mi (IMailInfo) - mail information object.
  • destinationFolder (string) - destination folder.
CreateFolder method (1.5 SR-2)

Creates mail folder. These are the method parameters:

  • folder (string) - folder name.
DeleteFolder method (1.5 SR-2)

Deletes mail folder. These are the method parameters:

  • folder (string) - folder name.
GetFolders method (1.5 SR-2)

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.
GetMailInfo method (1.5 SR-2)

Returns IMailInfo mail information object for specified identifier. These are the method parameters:

  • id (string) - mail identifier.
ConnectionType property (int)

Specify connection type. This property has the options listed in the following table.

Value Description
0 Unsecured IMAP connection.
1 Use Explicit SSL IMAP.
2 Use Implicit SSL IMAP.
3 Use Explicit TLS IMAP.
4 Use Implicit TLS IMAP.
ServerHost property (string)

Specify the name or IP address of the IMAP mail server.

ServerPort property (int)

Specify the port number on the IMAP mail server to use for the connection. The default value of this property is 110.

ServerUser property (string)

Specify user name to access the IMAP mail server.

ServerPassword property (string)

Specify user password to access the IMAP mail server.

Mailbox property (string)

Specify entry mailbox.

ServerTimeout property (int)

Specify the number of seconds before timing out session connect. The default value of this property is 100 seconds.

AuthenticationType property (int)

Specify authentication algorithm. This property has the options listed in the following table.

Value Description
0 Automatically determines and uses the most secure available method.
1 Uses TLS plain text authentication.
2 Uses DIGEST-MD5 authentication.
3 Uses CRAM-MD5 authentication.
4 Uses login authentication.
5 Uses clear text USER/PASS authentication.
6 Uses NTLM authentication.
7 Uses external authentication.
8 Uses GSSAPI/SSPI authentication.
LogFile property (string)

Specify verbose log file name for investigating IMAP connection issues.

RetainSameConnection property (bool)

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.
ProxyHost property (string)

Specify the name or IP address of the proxy server.

ProxyPort property (int)

Specify the port number on the proxy server to use for the connection.

ProxyUser property (string)

Specify user name to access the proxy server.

ProxyPassword property (string)

Specify password to access the proxy server.