API

Overview

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

ICacheConnection

When you call Distributed Cache Connection Manager AcquireConnection method, it returns object implementing ICacheConnection interface. This is the interface used for interaction with Windows AppFabric cache service.

Connect method

Connects to Windows AppFabric cache service. The method result is IDictionary object.

Close method

Closes the connection to Windows AppFabric cache service. Use always after you finish working with the service.

IsConnected method

Returns true if connected to the service.

Configuration property (string)

Specify cache configuration file.

Cache property (string)

Specify cache name. This parameter is optional. If not specified, the manager will return the default cache.

Region property (string)

Specify region inside cache. This parameter is optional.

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 uses different connection.

Overview

These public interfaces are used in Dynamics AX 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.Dynamics.BusinessConnectorNet.dll libraries.

IAxConnection

When you call Dynamics AX Connection Manager AcquireConnection method, it returns object implementing IAxConnection interface. This is the interface used for interaction with Dynamics AX server.

Connect method

Connects to Dynamics AX server. The method result is Axapta object.

Close method

Closes the connection to Dynamics AX server. Use always after you finish working with the server.

IsConnected method

Returns true if connected to the server.

GetTables method

Get list of Dynamics AX tables. These are the method parameters:

• accessType (int) - table access type. It can be one of the options listed in the following table.
  

  Value	Description
  0	Returns all tables, including tables without access.
  1	Returns tables, which can viewed
  2	Returns tables, which can be updated.
  3	Returns tables, which permit add.
  4	Returns tables, which permit delete.

GetTableFields method

Gets table fields. The method returns array of IAxTableField objects. These are the method parameters:

• table (string) - Dynamics AX table.

ServerUser property (string)

Specify user name to access Dynamics AX server.

ServerDomain property (string)

Specify the domain associated with the Windows user.

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 uses different connection.

ProxyUser property (string)

Specify Business Connector Proxy user.

ProxyPassword property (string)

Specify Business Connector Proxy password.

ProxyDomain property (string)

Specify Business Connector Proxy domain.

Company property (string)

Specify company you want to select for the session.

Language property (string)

Specify language to use for Microsoft Dynamics AX labels. For example, "en-us".

ObjectServer property (string)

Specify Microsoft Dynamics AX Application Object Server (AOS) to connect to. For example, Company1@AosInstance:PortNumber.

Configuration property (string)

Specify name of the Microsoft Dynamics AX configuration to use while logging on.

IAxTableField

This interface is used to retrieve table field information.

Id property (int)

Returns field identifier.

Name property (string)

Returns field name.

FieldType property (int)

Returns field type. The type can be one of the types listed here.

Length property (int)

Returns field length. Note: This property applies only to fields of type string.

Rights property (int)

Returns field access rights. It can be one of the options listed in the following table.

Value	Description
0	Field cannot be accessed.
1	Field can be viewed.
2	Field can be updated.

Overview

These public interfaces are used in SharePoint 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 CozyRoc.SharePoint.dll libraries. Also include CozyRoc.SharePoint.Lists, CozyRoc.SharePoint.Views namespaces.

ISharePointConnection

When you call SharePoint Connection Manager AcquireConnection method, it returns object implementing ISharePointConnection interface. This is the interface used for interaction with SharePoint service.

Connect method

Connects to SharePoint service.

Close method

Closes the connection to SharePoint service. Use always after you finish working with the service.

IsConnected method

Returns true if connected to the service.

GetService method

Get specific SharePoint web service. You have to connect first before use. The method has one parameter, which can be one of the options listed in the following table.

Value	Result Service
0	Lists Service
1	Views Service

ServerHost property (string)

Specify the name or IP address of the SharePoint server.

ServerUser property (string)

Specify user name to access the SharePoint service.

ServerPassword property (string)

Specify user password to access the SharePoint service.

ServerTimeout property (int)

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

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 uses 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.

Overview

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

IExcelConnection

When you call Excel Connection Manager AcquireConnection method, it returns object implementing IExcelConnection interface. This is the interface used for interaction with Excel workbook.

Connect method

Connects to Excel workbook.

Connect method

Connects to Excel workbook, loading from specified source stream. These are the method parameters:

• stream (Stream) - Excel workbook source stream.

Close method

Closes the connection to an Excel workbook. Use always after you finish working with the workbook.

IsConnected method

Returns true if connected to Excel workbook.

Save method

Saves Excel workbook.

Save method

Saves Excel workbook to stream. These are the method parameters:

• stream (Stream) - Target stream to store Excel workbook. If value is Nothing, the workbook is stored to the file specified in ExcelFilePath property.

GetCellValue method

Returns formatted cell value. These are the method parameters:

• sheet (int) - sheet index. Use GetSheetIndex method to retrieve sheet index.
• col (int) - cell column. The column is 1-based.
• row (int) - cell row. The row is 1-based.

GetCellRawValue method

Returns raw cell value. These are the method parameters:

• sheet (int) - sheet index. Use GetSheetIndex method to retrieve sheet index.
• col (int) - cell column. The column is 1-based.
• row (int) - cell row. The row is 1-based.

GetCellFormula method

Returns cell formula. These are the method parameters:

• sheet (int) - sheet index. Use GetSheetIndex method to retrieve sheet index.
• col (int) - cell column. The column is 1-based.
• row (int) - cell row. The row is 1-based.

SetCellValue method

Sets cell value. These are the method parameters:

• sheet (int) - sheet index. Use GetSheetIndex method to retrieve sheet index.
• col (int) - cell column. The column is 1-based.
• row (int) - cell row. The row is 1-based.
• value (object) - value to set in cell.

SetCellFormula method

Sets cell formula. These are the method parameters:

• sheet (int) - sheet index. Use GetSheetIndex method to retrieve sheet index.
• col (int) - cell column. The column is 1-based.
• row (int) - cell row. The row is 1-based.
• formula (string) - cell formula to set.

GetSheetsList method

Returns list of Excel worksheets.

NewSheet method

Creates new Excel worksheet. Returns worksheet index. These are the method parameters:

• name (string) - name of new worksheet.

RenameSheet method

Renames Excel worksheet. These are the method parameters:

• oldName (string) - worksheet old name.
• newName (string) - worksheet new name.

DeleteSheet method

Deletes Excel worksheet. These are the method parameters:

• name (string) - name of worksheet to delete.

ClearSheet method

Clears active Excel worksheet.

GetColumnsCount method

Returns number of used columns in Excel worksheet. These are the method parameters:

• name (string) - name of worksheet.

GetRowsCount method

Returns number of used rows in Excel worksheet. These are the method parameters:

• name (string) - name of worksheet.

DeleteColumns method

Delete columns in Excel worksheet. These are the method parameters:

• sheet (string) - sheet name.
• start (int) - delete start column. The column is 1-based.
• count (int) - number of columns to delete.

DeleteRows method

Delete rows in Excel worksheet. These are the method parameters:

• sheet (string) - sheet name.
• start (int) - delete start row. The row is 1-based.
• count (int) - number of rows to delete.

FindCell method

Finds cell value in worksheet. Returns false if value not found. These are the method parameters:

• value (object) - value to find.
• sheet (string) - sheet name.
• startCol (int) - start column. The column is 1-based.
• startRow (int) - start row. The row is 1-based.
• caseSensitive (bool) - set to true to perform case-sensitive search.
• foundCol (int) - returns found cell column. If value not found, result is -1.
• foundRow (int) - returns found cell row. If value not found, result is -1.

ReplaceCell method

Replaces cell value in worksheet. Returns the number of replacements. These are the method parameters:

• sheet (string) - sheet name.
• oldValue (object) - value to find.
• newValue (object) - replacement value.
• caseSensitive (bool) - set to true to perform case-sensitive search.

GetSheetIndex method

Returns worksheet index. These are the method parameters:

• name (string) - name of worksheet.

GetNamedRanges method

Returns list of named ranges in Excel worksheet. These are the method parameters:

• sheet (string) - name of worksheet.

GetNamedRangeRegion method

Returns named range region start position, width and height. These are the method parameters:

• sheet (string) - sheet name.
• rangeName (string) - range name.
• x (int) - returns range start column. The column is 1-based.
• y (int) - returns range start row. The row is 1-based.
• width (int) - returns range width.
• height (int) - returns range height.

ExcelFilePath property (string)

Specify path to Microsoft Excel file workbook to open.

FormatType property (int)

Specify Excel workbook format. This property has the options listed in the following table.

Value	Description
0	Automatically determines Excel workbook format from specified file extension (default).
1	97-2003 Excel workbook.
2	2007 Excel workbook.
3	Pocket Excel.

OpenPassword property (string)

Specify password to open Excel workbook.

ModifyPassword property (string)

Specify password to modify Excel workbook.

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.

Recalculate property (bool)

Specify to recalculate and update external references in Excel workbook on open. This property has the options listed in the following table.

Value	Description
True	Excel workbook is recalculated on open.
False	Excel workbook is not recalculated on open (default).

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.

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:

• mi (IMailInfo) - mail information object.

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.

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.

Overview

These public interfaces are used in Dynamics CRM 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 CozyRoc.Dynamics.dll libraries. Also include CozyRoc.Dynamics.Crm.Service, CozyRoc.Dynamics.Crm.MetadataService, CozyRoc.Dynamics.Crm.DiscoveryService namespaces.

ICrmConnection

When you call Dynamics CRM Connection Manager AcquireConnection method, it returns object implementing ICrmConnection interface. This is the interface used for interaction with Dynamics CRM service.

Connect method

Connects to Dynamics CRM service.

Close method

Closes the connection to Dynamics CRM service. Use always after you finish working with the service.

IsConnected method

Returns true if connected to the service.

GetService method

Get specific Dynamics CRM web service. These are the method parameters:

• service (int) – service type. It can be one of the options listed in the following table.
  

  Value	Result Service
  0	CrmService
  1	MetadataService
  2	CrmDiscoveryService. Note: Not available in CRM 3.0

GetEntityList method

Gets entities list with specific privilege. These are the method parameters:

• privilege (int) – entity privilege. It can be one of the options listed in the following table.
  

  Value	Description
  0	Privilege unspecified. All entities will be returned.
  1	Return entities, which permit record creation.
  2	Return entities, which can be read.
  3	Return entities, which can be updated.
  4	Return entities, which permit record removal.

Fetch method

Query Dynamics CRM service. The method returns XML string with the result of the query. These are the method parameters:

• fetchXML (string) FetchXML query statement.

GetEntityAttributes method

Get entity attributes. The method returns array of ICrmAttribute objects. These are the method parameters:

• entity (string) – entity name.

GetFetchAttributes method

Get attributes specified in query. The method returns array of ICrmAttribute objects. These are the method parameters:

• fetchXML (string) – FetchXML query statement.

ConstructEntity method

Construct object, which will be used to manipulate entity. The method returns ICrmEntity object. These are the method parameters:

• name (string) – entity name.

CreateEntityRecord method

Creates record in entity. The method returns string with identifier of the created record. These are the method parameters:

• entity (ICrmEntity) – object with create data.

UpdateEntityRecord method

Updates existing record in entity. These are the method parameters:

• entity (ICrmEntity) – object with update data.

DeleteEntityRecord method

Deletes record in entity. These are the method parameters:

• entity (string) – entity name.
• id (string) – identifier of record to delete.

DeploymentType property (int)

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

Value	Description
0	Connect to on-premise Dynamics CRM server.
1	Connect to Dynamics CRM Live service.
2	Connect to hosted Dynamics CRM.
3	Connect to Dynamics CRM 3.0 system. Note: When this option is selected, GetService method will return classes defined in CozyRoc.Dynamics.Crm3.Service, CozyRoc.Dynamics.Crm3.MetadataService namespaces.

ServerHost property (string)

Specify the name or IP address of the Dynamics CRM server.

ServerUser property (string)

Specify user name to access the Dynamics CRM service.

ServerPassword property (string)

Specify user password to access the Dynamics CRM service.

OrganizationName property (string)

Specify organization name. Note: Not available in CRM 3.0

ServerTimeout property (int)

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

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 uses 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.

ICrmAttribute

This interface is used to retrieve entity attributes information.

Name property (string)

Returns attribute name.

CanRead property (bool)

Returns true if attribute can be read.

CanCreate property (bool)

Returns true if attribute can be specified for record creation.

CanUpdate property (bool)

Returns true if attribute can be specified for record update.

CanUpdate property (bool)

Returns true if attribute is primary key.

AttributeType property (int)

Returns attribute type. It can be one of the options listed in the following table.

Value	Description
0	Boolean
1	Customer
2	DateTime
3	Decimal
4	Float
5	Integer
6	Internal
7	Lookup
8	Memo
9	Money
10	Owner
11	PartyList
12	Picklist
13	PrimaryKey
14	State
15	Status
16	String
17	UniqueIdentifier
18	Virtual
19	CalendarRules

Reference property (string)

Returns attribute entity reference if attribute is lookup.

RawAttribute property (object)

Returns internal AttributeMetadata object.

ICrmEntity

This interface is used to manipulate entity record.

AddProperty method

Add property. The method returns the index of the newly inserted property. These are the method parameters:

• name (string) – property name.
• attributeType (int) – attribute type. For valid values check AttributeType property in ICrmAttribute interface.
• reference (string) – entity reference. Only used when dealing with lookup attributes.

GetPropertiesCount method

Return count of properties.

SetPropertyValue method

Sets property value. These are the method parameters:

• index (int) – property index.
• value (object) – property value.

GetPropertyValue method

Returns property value. These are the method parameters:

• index (int) – property index.

ConstructDynamicEntity method

Constructs DynamicEntity object.

Name property (string)

Returns the entity name this object is associated with.

Overview

These public interfaces are used in Salesforce 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 library. Also include use of Sforce.Service namespace.

ISforceConnection

When you call Salesforce Connection Manager AcquireConnection method, it returns object implementing ISforceConnection interface. This is the interface used for interaction with Salesforce service.

Connect method

Connects to Salesforce service. The result is SforceService object.

Close method

Closes the connection to Salesforce service. Use always after you finish working with the service.

IsConnected method

Returns true if connected to the service.

ServerUser property (string)

Specify user name to access the Salesforce service.

ServerPassword property (string)

Specify user password to access the Salesforce service.

ServerTimeout property (int)

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

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 uses different connection.

ServerUrl property (string) (1.4 SR-1)

Specify Salesforce service URL. This property should be explicitly specified when doing sandbox testing.

ProxyHost property (string) (1.4 SR-3)

Specify the name or IP address of the proxy server.

ProxyPort property (int) (1.4 SR-3)

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

ProxyUser property (string) (1.4 SR-3)

Specify user name to access the proxy server.

ProxyPassword property (string) (1.4 SR-3)

Specify password to access the proxy server.

Overview

These public interfaces are shared across various SSIS+ 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 library.

IFileInfo (1.2 SR-2)

This interface is used to retrieve extended file information.

Name property (string)

Returns file name.

FullName property (string)

Returns full file name.

Size property (long)

Returns file size.

ModifiedTime property (DateTime)

Returns file modification time.

IsDirectory property (bool)

Returns true if directory.

IFtpClient (1.3)

This interface is used to access services provided by SFTP and FTPS servers.

SetWorkingDirectory method

Sets current remote working directory. These are the method parameters:

• path (string) - remote directory path.

GetWorkingDirectory method

Get current remote working directory. The method result is the remote path.

IsDirectory method

Returns true if specified remote path is directory. These are the method parameters:

• path (string) - remote path.

SendFile method

Uploads files to remote server. These are the method parameters:

• src (string) - path to source local file(s).
• dest (string) - path to destination remote directory.
• overwrite (bool) - set to true, if you want to overwrite existing remote files.

SendStream method

Uploads stream of data to remote server. These are the method parameters:

• src (Stream) - stream of data to upload.
• dest (string) - path to destination remote file.

ReceiveFile method

Downloads files from remote server. These are the method parameters:

• src (string) - path to source remote file(s).
• dest (string) - path to destination local directory.
• overwrite (bool) - set to true, if you want to overwrite existing local files.

ReceiveStream method

Downloads stream of data from remote server. The method result is Stream to source remote file. These are the method parameters:

• src (string) - path to source remote file.

SetFileTime method

Sets remote file modified time. These are the method parameters:

• file (string) - path to remote file.
• time (DateTime) - new time of remote file.

CreateDirectory method

Creates remote directory. These are the method parameters:

• directory (string) - remote directory path.

DeleteDirectory method

Deletes remote directory. These are the method parameters:

• directory (string) - remote directory path.

DeleteFile method

Deletes remote file. These are the method parameters:

• file (string) - path to remote file.

RenameFile method

Renames remote file. These are the method parameters:

• oldFile (string) - path to remote file to rename.
• newFile (string) - new file name path.

GetListing method

Gets listing of remote files. The method result is array of IFileInfo objects. These are the method parameters:

• searchPath (string) - path to remote directory you want to retrieve the listing for.
• isWildcard (bool) - specifies if searchPath contains wildcard expression or it is simply a remote path.
• includeDir (bool) - specifies if result listing contains remote directories.

GetListing method (1.5)

Gets listing of remote files. The method result is array of IFileInfo objects. These are the method parameters:

• searchPath (string) - path to remote directory you want to retrieve the listing for.
• isWildcard (bool) - specifies if searchPath contains wildcard expression or it is simply a remote path.
• includeDir (bool) - specifies if result listing contains remote directories.
• recursive (bool) - specifies to recursively retrieve all remote files, starting from searchPath.
• filter (string) - specifies FLEE filter expression. You can use the members from IFileInfo interface.

IMailInfo (1.5)

This interface is used to retrieve extended mail information.

ID property (string)

Returns mail identifier.

Date property (DateTime)

Returns mail origination date and time.

Size property (long)

Returns mail size.

From property (string)

Returns mail authors.

To property (string)

Returns primary mail recipients.

CC property (string)

Returns other mail recipients.

ReplyTo property (string)

Returns recipients that should receive reply to this mail.

Subject property (string)

Returns mail subject.

BodyText property (string)

Returns mail text body.

BodyHtml property (string)

Returns mail HTML body.

HasAttachments property (bool)

Returns true if mail has attachments.

Headers property (IDictionary)

Returns mail headers.

GetAttachments method

Gets mail attachments. These are the method parameters:

• folder (string) - path to destination local directory.
• overwrite (bool) - set to true, if you want to overwrite existing local files.

IMailClient (1.5)

This interface is used to access services provided by POP3 and IMAP mail servers.

GetMail method

Gets mail from server. These are the method parameters:

• mi (IMailInfo) - mail information object.
• filename (string) - path to destination local file.

GetMailStream method

Gets mail stream from server. The method result is Stream to message. These are the method parameters:

• mi (IMailInfo) - mail information object.

DeleteMail method

Deletes mail from server. These are the method parameters:

• mi (IMailInfo) - mail information object.

GetMails method

Gets mails list from server. These are the method parameters:

• search (string) - search criteria. The expression entry for each connection is as follows:
  

  Connection	Description
  POP3	FLEE expression. The elements you can use are the properties available in IMailInfo interface.
  IMAP	IMAP SEARCH COMMAND expression.