POP3 API

Overview

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

IPop3Connection

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

Connect method

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

Close method

Closes the connection to a POP3 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.

ConnectionType property (int)

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

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

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

ServerPort property (int)

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

ServerUser property (string)

Specify user name to access the POP3 mail server.

ServerPassword property (string)

Specify user password to access the POP3 mail server.

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 APOP authentication.
7 Uses NTLM authentication.
8 Uses GSSAPI/SSPI authentication.
LogFile property (string)

Specify verbose log file name for investigating POP3 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.