SMTP API

Overview

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

ISmtpConnection

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

Connect method

Connects to SMTP mail server.

Close method

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

SendMail method

Sends mail file to remote server. These are the method parameters:

  • mail (string) - mail stream to upload.
SendStream method

Sends mail stream to remote server. These are the method parameters:

  • mail (Stream) - mail stream to upload.
ConnectionType property (int)

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

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

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

ServerPort property (int)

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

ServerUser property (string)

Specify user name to access the SMTP mail server.

ServerPassword property (string)

Specify user password to access the SMTP 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 NTLM authentication.
6 Uses GSSAPI/SSPI authentication.
LogFile property (string)

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