Common API

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)

DEPRECATED: Use SentDate instead.
Returns mail origination date and time.

SentDate property (DateTime) (1.6 SR-2)

Returns mail origination date and time.

ReceivedDate property (DateTime) (1.6 SR-2)

Returns mail received 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.

Attachments property (string[]) (1.5 SR-4)

Returns list of attachments name.

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:

DeleteMail method

Deletes mail from server. These are the method parameters:

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.
CopyMail method (1.6 SR-1)

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

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

Creates mail folder. These are the method parameters:

  • folder (string) - new mail folder.
DeleteFolder method (1.6 SR-1)

Delete mail folder. These are the method parameters:

  • folder (string) - mail folder.
GetFolders method (1.6 SR-1)

Returns mail folder list. The method result is array of mail folders. These are the method parameters:

  • parent (string) - parent mail folder.
GetMailInfo method (1.6 SR-1)

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

  • id (string) - mail identifier.
SetMailSeen method (1.6 SR-2)

Sets mail as read or not read. These are the method parameters:

  • mi (IMailInfo) - mail information object.
  • seen (bool) - specify mail is read or not.