This guide is intended as a supplement to the EFT Server/Secure FTP Server user guides. For an understanding of the concepts in this supplement, please refer to those guides.
You can interact with GlobalSCAPE's server products directly from your own custom applications using any COM-enabled programming language such as Visual Basic (VB), Java, or C++, with the integrated development environment (IDE) of your choice. To create a new script file or program, you need to have some familiarity with programming concepts and, ideally, some experience with a COM-enabled programming language.
Scroll through the table of contents to the left to find the action that you want to perform, or use the Search feature of help to locate words or phrases within the content of the topics. The Index tab provides an alphabetical listing of every method and property in the COM API.
|
|
This guide is intended as a supplement to the EFT Server/Secure FTP Server user guides. For an understanding of the concepts in this supplement, please refer to those guides. |
The SFTPCOMInterface.CIServer class is the class that an application can use directly. To start using the SFTP COM interface, a user application should create the SFTPCOMInterface.CIServer class object, and then apply the methods and properties in the object.
For example: Set SFTPServer = CreateObject("SFTPCOMInterface.CIServer")
CIServer implements the ICIServer interface.
Server Interface Methods and Server Interface Properties- Use the ICIServer interface to access and manage the server and its attributes.
Multiple Sites Interface Methods - Use the ICISites interface to list all Sites, to add Sites, and to find individual Sites on the server. It can be obtained by using the Sites method of the ICIServer interface.
Single-Site Interface Methods and Single-Site Interface Properties - Use the ICISite interface to manage individual Sites on the server. It can be obtained by using the Item and SiteByID methods of the ICISites interface.
For example: Set Site = Sites.Item(0)
Permissions Interface Properties - Use the IPermission interface to set and manage folder permissions. Use the ICISite::GetFolderPermissions method to get folder permissions.
Client Settings Interface Methods and Client Setting Interface Properties - Use the ICIClientSettings interface to manage client user or client group settings. Use the ICISite::GetGroupSettings method to access the interface.
Command Settings Interface Methods and Command Settings Interface Properties - Use the ICICommandSettings interface to create or manage Site custom commands. Use the ICISite::GetCommandSettings method to access the interface.
Certificate Interface Properties - Use the ICICertInfo interface to obtain information about certificates. Use the ICISite::GetTrustedCertificateInfo method or the ICISite::GetPendingCertificateInfo method to access the interface.
Mail Action Parameters Interface - (EFT Server 5.2 and later) Use the ICIMailActionParams interface to make changes to the MailAction settings, such as email subject, email body, and to addresses, CC addresses, and BCC addresses.
Cleanup Action Parameters Interface - (EFT Server 5.2 and later) Use the ICICleanupActionParams interface to make changes to the Cleanup in Folder Event Action settings.
OpenPGP Action Interface (ICIPgpActionParams) - (EFT Server 5.2 and later) Use the ICIPgpActionParams interface to make changes to the OpenPGP Event Action settings.
Event Rule Interfaces - (EFT Server 5.2 and later) Use the Event Rule interfaces to manage Event Rules and their Events, Actions, and Conditions.
For script examples, see Sample Script and Setting Permissions.