List of Methods, Properties, Enumerators, and Constants

The tables below list each of the methods, properties, enumerators, and constants used in Secure FTP Server/EFT Server. The Applicable Version column indicates in which product and version number the method/property/enumeration/constant is available. In most cases, the method, property, enumeration, or constant applies to both products, all versions.

Server Interface Properties
Server Interface Methods
Multiple Sites Interface Methods
Single-Site Interface Properties
Single-Site Interface Methods
Permissions Interface Properties
Audit Interface Methods
Client Settings Interface Properties
Client Settings Interface Methods
Command Settings Interface Properties
Command Settings Interface Methods
CommandActionParams Interface Properties
Certificate Information Interface Properties
MailActionParams Interface Properties
CleanupActionParams Interface Properties
OpenPGP Action Interface Properties

Event Rule Interfaces:

Server Interface Properties

Property	How It's Used	Applicable Version
AdminPort	Editing the Administrator Port	All versions
AllowClearCommandChannel	Allowing a Clear Command Channel on the Server	EFT Server 5.0.1 and later
AllowRemoteAdministration	Allowing Remote Administration	All versions
AllowUnprotectedDataChannel	Allowing an Unprotected Data Channel on the Server	EFT Server 5.0.1 and later
ARMDatabaseName	Editing the ARM Database Name	Secure FTP Server 3.3
ARMPassword	Editing the ARM Password	Secure FTP Server 3.3
ARMServerName	Editing the ARM Server Name	Secure FTP Server 3.3
ARMUserName	Editing the ARM Username	Secure FTP Server 3.3
CertificateFilePath	Editing the File Path for Certificates	All versions
CipherList	Editing the Cipher List	EFT Server 5.0.1 and later
ConnectedUsersNumber	Retrieving the Number of Connected Users	EFT Server 3.5.1 and later
EnableARM	Enabling Auditing and Reporting	All versions
IPAccessAllowedDefault	Finding or Setting the Default IP Access Mode	All versions
KeyFilePath	Editing the File Path for Private Key Files	All versions
ListenIP	Editing the Server Administrator IP Address	All versions
LogPath	Editing the Server Log Path	All versions
LogRotation	Rotating Logs	All versions
LogType	Editing the Server Log Type	All versions
PassPhrase	Editing Private Key Passphrases	All versions
SMTPLogin	Editing the Email User Name	All versions
SMTPPassword	Editing the Email Password	All versions
SMTPPort	Editing the Mail Server Port	All versions
SMTPRecipientAddr	Choosing Email Receiver Addresses	All versions
SMTPRecipientName	Choosing Email Receiver Names	All versions
SMTPSenderAddr	Choosing the From Address in Server Emails	All versions
SMTPSenderName	Choosing the Server Email Sender Name	All versions
SMTPServer	Editing the Mail Server Address	All versions
SSLVersionMask	Retrieving or Setting the SSL Version Mask	EFT Server 5.0.1
UseSSLForAdministration	Requiring SSL for Remote Administration	All versions

Server Interface Methods

Method	How It's Used	Applicable Version
AddIPAccessRule	Adding an IP Mask	All versions
ApplyChanges	Applying Changes to the Server	Versions prior to EFT Server 5.0
AreLingeringTransactions	Determining if Lingering Transactions Exist	EFT Server 5.2 and later
Auditor	Retrieving the Audit Interface (Auditor)	EFT Server 6.0
ChangeAdminPassword	Changing the Administrator Password	EFT Server 4.3.4
Close	Closing the Administrator Connection to the Server	All versions
Connect	Connecting to the Server as an Administrator	All versions
GetAdminIPs	Retrieving a List of Administrator IP Addresses	EFT Server 4.3.4
GetAllowedMasks	Retrieving Allowed IP Address Masks	All versions
GetDeniedMasks	Retrieving Denied IP Address Masks	All versions
GetLocalIP	Retrieving the Local IP Address	All versions
GetLocalTime	Retrieving the Local Server Time	All versions
GetServerAdminCount	Retrieving the Number of Server Administrator Accounts on the Server	EFT Server 4.3.4
IsDBConnected	Determining if Server is Connected to the ARM Database	EFT Server 5.2 and later
RefreshSettings	Refreshing Server Settings	All versions
RemoveIPAccessRule	Removing an IP Address Mask	All versions
RemoveServerAdminAccount	Removing a Server Administrator Account	EFT Server 4.3.4
Sites	Retrieving a List of Server Sites	All versions

Multiple Sites Interface Methods

Method	How It's Used	Applicable Version
Add	Adding a Site	All versions
AddADSite	Adding an Active Directory Authenticated Site	All versions
AddLDAPSite	Adding an LDAP Site	EFT Server 4.3.4
AddLocalSite	Adding a Local Site	All versions
AddNTLMSite	Adding an NT-Authenticated Site	All versions
AddODBCSite	Adding an ODBC-Authenticated Site	All versions
Count	Retrieving the Number of Sites	All versions
Item	Retrieving a Site's COM Interface by Site Number	All versions
SiteByID	Retrieving a Site's COM Interface by Site ID	All versions

Single-Site Interface Properties

Property	How It's Used	Applicable Version
AssignFullPermissionsForHomeFolder	Setting the Grant Full Permissions Option	All versions
AutoBanIPsPermanently	Banning IP Addresses	All versions
AutoCreateHomeFolder	Setting the Auto Create Home Folder Option	All versions
BanIPOnDOS	Banning Connections from Specific IP Addresses	All versions
BlockAntiTimeOut	Blocking Anti-Timeout Schemes	All versions
BlockSiteToSite	Blocking Site-to-Site FTP	All versions
ConnectMessage	Editing the Server Connection Message	All versions
DisconnectOnDOS	Limiting Consecutive Invalid Commands	All versions
DOSLimit	Managing the Consecutive Invalid Commands Limit	All versions
EnablePortRange	Enabling a Range of Ports for PASV Connections	All versions
ExitMessage	Managing a Site's Exit Message	All versions
HasMaxConcurrentLogins	Retrieving Maximum Concurrent Logins	Secure FTP Server
HasMaxConnectionsPerAccount	Retrieving or Setting Number of Connections per User to a Site	All versions
HasMaxIPPerAccount	Limiting Connections from the Same IP Address	All versions
HasMaxSpeed	Enabling or Disabling a Site's Maximum Transfer Speed	All versions
HasMaxUsers	Limiting Concurrent Connections to a Site	All versions
ID	Retrieving a Site's ID	All versions
InvalidAttemptsPeriod	Viewing Invalid Attempts Period for a Site	EFT Server 5.1.1 and later
IPAccessAllowedDefault	Setting IP Addresses that have Access to a Site	All versions
IsStarted	Determining if a Site is Started	All versions
LimitLoginAttempts	Enabling Allowed Login Attempt Limit	EFT Server 5.1.1 and later
LockoutNotDisable	Enabling Account Lockout	EFT Server 5.1.1 and later
LockoutPeriod	Viewing the Lockout Period for a Site	EFT Server 5.1.1 and later
MaxConcurrentConnections	Retrieving or Setting Maximum Concurrent Connections	All versions
MaxConnectionsFromSameIP	Managing Concurrent Connections Allowed from the Same IP Address	All versions
MaxConcurrentLogins	Setting Maximum Concurrent Logins	Secure Server, All versions
MaxConnectionsPerUser	Retrieving or Setting a Site's User Connection Limit	All versions
MaxInvalidLoginAttempts	Viewing the Number of Invalid Login Attempts Allowed for a Site	EFT Server 5.1.1 and later
MaxTransferSpeed	Retrieving or Setting Maximum Transfer Speed	All versions
Name	Retrieving a Site's Name	All versions
ODBCSettings	Retrieving ARM ODBC Settings	EFT Server 4.3.4
PASVListenIP	Determining the IP Address for PASV Connections	All versions
PASVPortMax	Determining the High End of a PASV Mode Port Range	All versions
PASVPortMin	Determining the Low End of a PASV Mode Port Range	All versions
UserLimitMessage	Managing the User Limit Message	All versions
VFSFilter	Retrieving and Modifying a List of Banned File Types	All versions

Single-Site Interface Methods

Method	How It's Used	Applicable Version
AddCerficateToTrusted	Adding a Pending Certificate to the Trusted List	All versions
AddIPAccessRule	Adding an IP Mask to a Site	All versions
AddUserToPermissionGroup	Adding a User to a Permission Group	All versions
AssignEventRuleCustomCommandWorkingFolder	Assigning the Event Rule Custom Command Working Folder	EFT Server 4.3.4
CancelTransfer	Cancelling an HTTPS Transfer	EFT Server 4.3.4
ChangeUserPassword	Changing a User's Password	All versions
CreateCommand	Creating a New Custom Command	All versions
CreateComplexPassword	Creating a Complex Password for a User	EFT Server 5.0.1 and later
CreatePermissionGroup	Creating a Permissions Group	All versions
CreatePhysicalFolder	Creating a Physical Folder	All versions
CreateSettingsLevel	Creating a User Settings Level	All versions
CreateUser and CreateUserEx	Creating a User	All versions
CreateVirtualFolder	Creating a Virtual Folder	All versions
EventRules	Retrieving a List of Event Rules	EFT Server 5.2 and later
ExportTrustedCertificate	Retrieving a Certificate's Data String	All versions
ForceSynchronizeUserDatabase	Synchronizing the User Database	All versions
GetAllowedMasks	Retrieving a List of Allowed IP Masks	All versions
GetAuthManagerID	Identifying the Authentication Manager for a Site	All versions
GetAwaitingCertsPath	Retrieving the Path to Pending Certificates	All versions
GetBlankPermission	Creating Blank Permissions	All versions
GetCertFilePath	Retrieving the File Path for Certificates	All versions
GetCheckClientCert	Verifying if Client Certificates are Required	All versions
GetCommands	Retrieving a List of Custom Commands	All versions
GetCommandSettings	Retrieving a Custom Command's Settings	All versions
GetConnectedCount	Retrieving the Number of Connected Users	All versions
GetConnectedUsers	Retrieving a List of Connected Users	EFT Server 4.3.4
GetDeniedMasks	Retrieving a List of Denied IP Address Masks	All versions
GetDownloadCount	Retrieving the Number of Active Downloads	All versions
GetDownloadSpeed	Retrieving a Site's Download Speed	All versions
GetFolderList	Retrieving a List of Folders	All versions
GetFolderPermissions	Retrieving a List of Folder Permissions	All versions
GetFTPAccess	Verifying if FTP Access is Enabled for a Site	All versions
GetHTTPAccess	Verifying if HTTP is Enabled for a Site	EFT Server 4.3.4
GetHTTPPort	Retrieving the HTTP Port for a Site	EFT Server 4.3.4
GetHTTPSAccess	Verifying if HTTPS is Enabled for a Site	EFT Server 4.3.4
GetHTTPSPort	Retrieving the HTTPS Port for a Site	EFT Server 4.3.4
GetIP	Retrieving a Site's IP Address	All versions
GetKeyFilePath	Retrieving the File Path for Private Keys	All versions
GetPassPhrase	Retrieving Private Key Passphrases	All versions
GetPendingCertificateInfo	Retrieving Information for a Pending Certificate	All versions
GetPendingCertificates	Retrieving a List of Pending Certificates	All versions
GetPermissionGroupList	Retrieving a List of Users of Specified Permission Groups	All versions
GetPermissionGroups	Retrieving a List of Permission Groups on a Site	All versions
GetPermissionGroupsOfUser	Retrieving a List of a User's Permission Groups	All versions
GetPhysicalPath	Retrieving the Physical Path to a Virtual Folder	EFT Server 5.2.5
GetPort	Retrieving a Site's Port Number	All versions
GetRootFolder	Retrieving a Site's Root Folder	All versions
GetSettingsLevels	Retrieving a List of User Settings Levels	All versions
GetSettingsLevelSettings	Retrieving a List of a Settings in a User Settings Level	All versions
GetSettingsLevelUsers	Retrieving a List of Users in a User Settings Level	All versions
GetSSHKeyFilePath	Retrieving the SFTP (SSH) Certificate File Path	EFT Server 4.3.4
GetSSLAuth	Verifying if Explicit SSL is Enabled for a Site	All versions
GetSSLImp	Verifying if Implicit SSL is Enabled for a Site	All versions
GetStartTime	Retrieving the Site Start Time	All versions
GetTrustedCertificateInfo	Retrieving Information for a Trusted Certificate	All versions
GetTrustedCertificates	Retrieving a List of Trusted Certificates	All versions
GetTrustedCertsPath	Retrieving the Path to Trusted Certificates	All versions
GetUploadCount	Retrieving the Number of Active Uploads	All versions
GetUploadSpeed	Retrieving a Site's Upload Speed	All versions
GetUsers	Retrieving a List of Users	All versions
GetUserSettings	Retrieving a User's Settings	All versions
ImportTrustedCertificate	Saving a Trusted Certificate to a File	All versions
KickUser	Forcing a User to Log Off of the Site	EFT Server 4.3.4
MoveUserToSettingsLevel	Moving a User to a User Settings Level	All versions
RemapVirtualFolder	Remapping a Virtual Folder Path	EFT Server 4.3.4
Remove	Deleting a Site	All versions
RemoveCommand	Deleting a Custom Command	All versions
RemoveFolder	Deleting a Folder	All versions
RemoveIPAccessRule	Removing an IP Address Mask from a Site	All versions
RemovedPendingCertificate	Deleting a Pending Certificate	All versions
RemovePermission	Removing Folder Permissions	All versions
RemovePermissionGroup	Deleting a Permission Group	All versions
RemoveSettingsLevel	Deleting a User Settings Level	All versions
RemoveTrustedCertificate	Deleting a Trusted Certificate	All versions
RemoveUser	Deleting a User	All versions
RemoveUserFromPermissionGroup	Deleting a User from a Permission Group	All versions
RenameFolder	Renaming a Folder	All versions
RenamePermissionGroup	Renaming a Permission Group	All versions
RenameSettingsLevel	Renaming a Settings Level	All versions
RenameUser	Renaming a User	All versions
SetCertFilePath	Changing the Certificate File Path	All versions
SetCheckClientCert	Requiring User Certificates on Implicit SSL Sites	All versions
SetFTPAccess	Enabling FTP Access to a Site	All versions
SetHTTPAccess	Enabling HTTP Access	EFT Server 4.3.4
SetHTTPPort	Specifying the HTTP Port	EFT Server 4.3.4
SetHTTPSAccess	Enabling HTTPS Access	EFT Server 4.3.4
SetHTTPSPort	Specifying the HTTPS Port	EFT Server 4.3.4
SetIP	Specifying a Site's IP Address	All versions
SetKeyFilePath	Changing the Private Key File Path	All versions
SetPassPhrase	Changing a Private Key Passphrase	All versions
SetPermission	Setting Folder Permissions	All versions
SetPort	Specifying a Site's Port Number	All versions
SetRootFolder	Specifying the Site's Root Folder	All versions
SetSSHKeyFilePath	Specifying the SFTP (SSH) Certificate File Path	EFT Server 4.3.4
SetSSLAuth	Allowing Explicit SSL Access to a Site	All versions
SetSSLImp	Allowing Implicit SSL Access to a Site	All versions
Start	Starting a Site	All versions
Stop	Stopping Site	All versions
ValidatePassword	Validating a User's Password	EFT Server 3.5.1 and later

Permission Interface Properties

Property	How It's Used	Applicable Version
Client	Retrieving a Client or Permission Group Name	All versions
DirCreate	Granting Folder Creation Permission	All versions
DirDelete	Granting Folder Deletion Permission	All versions
DirList	Granting Permission to View a List of Folder Contents	All versions
DirShowHidden	Showing Hidden Files	All versions
DirShowInList	Showing or Hiding Folders	All versions
DirShowReadOnly	Showing Read-Only Files	All versions
FileAppend	Granting Append File Permission	All versions
FileDelete	Granting Delete Permission	All versions
FileDownload	Granting Download Permission	All versions
FileRename	Granting Rename Permission	All versions
FileUpload	Granting Upload Permission	All versions
Folder	Retrieving a Folder Name	All versions

Audit Interface Properties

Property	How It's Used	Applicable Version
AuditSATEmail	Auditing a SAT E-mail in ARM	EFT Server 6.0
AuditSATFile	Auditing a SAT File in ARM	EFT Server 6.0
AuditSATTransaction	Auditing a SAT Transaction in ARM	EFT Server 6.0

Client Settings Interface Properties

Property	How It's Used	Applicable Version
Comment	Viewing User Properties - Comments	All versions
Custom	Viewing User Properties - Custom1, Custom2, Custom3	EFT Server v5.0.1 and later
Email	Viewing User Properties - Email	All versions
Fax	Viewing User Properties - Fax	All versions
FullName	Viewing User Properties - Full Name	All versions
InvalidAttemptsPeriod	Viewing Invalid Attempts Period for a User	EFT Server 5.1.1 and later
IPAccessAllowedDefault	IP addresses with which a user is allowed to connect to the Server	EFT Server 5.1.1 and later
LockoutPeriod	Viewing a User's Lockout Period	EFT Server 5.1.1 and later
MaxInvalidLoginAttempts	Viewing the Number of Invalid Login Attempts Allowed for a Client	EFT Server 5.1.1 and later
Pager	Viewing User Properties - Pager	All versions
Phone	Viewing User Properties - Phone	All versions

Client Settings Interface Methods

Method	How It's Used	Applicable Version
AddIPAccessRule	Adding an IP Access IP Mask for a Client	EFT Server 5.1.1 and later
ForcePasswordChange	Forcing a User to Change Password on Login	EFT Server 6.0
GetAllowAnyPwd	Determining if Users Can Create Any Password	All versions
GetAllowedMasks	Retrieving Allowed IP Masks for a User	EFT Server 5.1.1 and later
GetAllowMODEZ	Determining if ModeZ is Allowed	All versions
GetAllowNoop	Determining if the NOOP Command is Allowed	All versions
GetAllowXCRC	Determining if the XCRC Command is Allowed	All versions
GetAnonymousLogin	Viewing Anonymous Logins	All versions
GetAppletEnabled	Determining Web Transfer Client Access	EFT Server 3.5.1 and later
GetChangePwd	Determining if Users are Allowed to Change their Passwords	All versions
GetClearFTP	Determining if Plain FTP Access is Allowed	All versions
GetClearHTTP	Determining if Plain HTTP Access is Allowed	EFT Server 4.3.4 and EFT Server 5.1
GetDeniedMasks	Retrieving Denied IP Mask for a User	EFT Server 5.1.1 and later
GetDescription	Retrieving a User's Description	All versions
GetDownloadsPerSession	Retrieving a Download per Session Limit	All versions
GetEnableAccount	Determining if a User Account or User Settings Level is Enabled	All versions
GetEnableDiskQuota	Determining if an Account has a Disk Quota	All versions
GetEnableTimeOut	Determining if a User Can be Timed Out	All versions
GetExpirationDate	Determining the Expiration Date for a User Account	All versions
GetExpirationDateAsVariant	Determining the Expiration Date for a User Account	EFT Server 4.3.4 and later
GetFTPS	Viewing if FTPS is Enabled for a Client (GetFTPS)	EFT Server 6.0
GetHasDownloadsPerSession	Determining if a User has a Download per Session Limit	All versions
GetHasMaxDownloadSize	Determining if a User has a Download Size Limit	All versions
GetHasMaxIPs	Determining for an IP Connection Limit	All versions
GetHasMaxSpeed	Determining if a User has a Transfer Speed Limit	All versions
GetHasMaxUploadSize	Determining if a User has an Upload Size Limit	All versions
GetHasMaxUsers	Determining if the Number of Concurrent Connections is Limited for Users	All versions
GetHasPwdRetries	Determining Failed Password Limit	All versions
GetHasUploadsPerSession	Determining if a User has an Upload per Session Limit	All versions
GetHomeDir	Determining if Users Can Have a Home Folder	All versions
GetHomeDirIsRoot	Determining if the Account Home Folder is the Default Root Folder	All versions
GetHomeDirString	Retrieving Users' Home Folders	All versions
GetHomeIP	Determining if Users are Restricted to a Specific IP Address	All versions
GetHomeIPString	Retrieving Users' Home IP Address	All versions
GetHTTPS	Viewing if HTTPS is Enabled for a Client (GetHTTPS)	EFT Server 6.0
GetIncorrectPasswordAttempts	Determining the Number of Failed Password Attempts	All versions
GetLimitLoginAttempts	Retrieving Number of Login Attempts Allowed	EFT Server 5.1.1 and later
GetLockoutNotDisable	Viewing Whether Account Lockout is Enabled for a User	EFT Server 5.1.1 and later
GetLoginMsg	Determining How Users' Login Message is Defined	All versions
GetLoginMsgString	Retrieving the Login Message	All versions
GetMaxDownloadSize	Retrieving a User's Download Size Limit	All versions
GetMaxIPs	Determining Number of Connections Allowed from the Same IP Address	All versions
GetMaxSpace	Determining the Disk Quota Size	All versions
GetMaxSpeed	Determining the Maximum Allowed Transfer Speed	All versions
GetMaxUploadSize	Retrieving a User's Upload Size Limit	All versions
GetMaxUsers	Determining the Maximum Concurrent Connections Allowed per User	All versions
GetPwdRetries	Retrieving the Failed Password Limit	All versions
GetSFTP	Viewing if SFTP Access is Enabled for a Client	All versions
GetSFTPAuthenticationType	Identifying the SFTP Authentication Type	All versions
GetSSHKeyID	Retrieving the SFTP (SSH) Certificate ID	All versions
GetSSL	Determining if SSL Access is Allowed	All versions
GetSSLAuthenticationType	Identifying the SSL Authentication Type	EFT Server 5.1 and later
GetSSLKeyID	Identifying the SSL Key ID	EFT Server 5.1 and later
GetTimeOut	Determining How Long a Connection can be Inactive	All versions
GetUploadsPerSession	Retrieving a User's Upload per Session Limit	All versions
GetUsedSpace	Determining How Much Disk Space a User has Used	All versions
RemoveIPAccessRule	Removing an IP Access Mask for User	EFT Server 5.1.1 and later
SetAllowAnyPwd	Allowing Users to Create Any Password	All versions
SetAllowMODEZ	Allowing MODE Z Compression	All versions
SetAllowNoop	Allowing the NOOP Command	All versions
SetAllowXCRC	Allowing the XCRC Command	All versions
SetAnonymousLogin	Allowing or Prohibiting Anonymous Logins	All versions
SetAppletEnabled	Specifying Web Transfer Client Access	EFT Server 3.5.1 and later
SetChangePwd	Allowing Users to Change their Passwords	All versions
SetClearFTP	Allowing Users Plain FTP Connections	All versions
SetClearHTTP	Allowing Users to Connect Using Clear HTTP	EFT Server 4.3.4 and EFT Server 5.1
SetDescription	Specifying a User Description	All versions
SetDownloadsPerSession	Specifying the Maximum Number of Downloads a User is Permitted per Session	All versions
SetEnableAccount	Enabling a User Account or User Settings Level	All versions
SetEnableDiskQuota	Limiting a User's Disk Space	All versions
SetEnableTimeOut	Enabling Connection Timeout	All versions
SetExpirationDate	Setting the Expiration Date for a User Account	All versions
SetHasDownloadsPerSession	Enabling a User's Downloads-per-Session Limit	All versions
SetHasMaxDownloadSize	Enabling a User's Download Size Limit	All versions
SetHasMaxIPs	Enabling an IP Address Connection Limit	All versions
SetHasMaxSpeed	Enabling the Transfer Speed Limit	All versions
SetHasMaxUploadSize	Enabling a User's Upload Size Limit	All versions
SetHasMaxUsers	Enabling a User's Connection Limit	All versions
SetHasPwdRetries	Limiting Failed Password Attempts	All versions
SetHasUploadsPerSession	Enabling a User's Uploads-per-Session Limit	All versions
SetHomeDir	Allowing Users to Have a Home Folder	All versions
SetHomeDirIsRoot	Setting the Default Root Folder	All versions
SetHomeDirString	Specifying the Path to Users' Home Folders	All versions
SetHomeIP	Restricting Users to a Specific IP Address	All versions
SetHomeIPString	Setting Users' Home IP Address	All versions
SetIncorrectPasswordAttempts	Specifying the Number of Incorrect Password Attempts	All versions
SetLimitLoginAttempts	Specifying Number of Login Attempts Allowed	EFT Server 5.1.1 and later
SetLockoutNotDisable	Enabling Account Lockout for a User	EFT Server 5.1.1 and later
SetLoginMsg	Specifying the Login Message Used	All versions
SetLoginMsgString	Creating a Login Message	All versions
SetMaxDownloadSize	Specifying the Maximum File Size a User is Permitted to Download	All versions
SetMaxIPs	Specifying the Maximum Connections for IP Addresses	All versions
SetMaxSpace	Specifying a User's Disk Quota	All versions
SetMaxSpeed	Specifying the Maximum Allowed Transfer Speed	All versions
SetMaxUploadSize	Specifying the Maximum File Size a User is Permitted to Upload	All versions
SetMaxUsers	Specifying the Maximum Connections Allowed per User	All versions
SetPwdRetries	Specifying the Failed Password Limit	All versions
SetSFTP	Allowing SFTP Access for a Client	All versions
SetSftpAuthenticationType	Specifying the SFTP Authentication Type for the Client	All versions
SetSSHKeyID	Specifying the SFTP (SSH) Certificate ID	All versions
SetSSL	Allowing Users SSL Connections	All versions
SetSSLAuthenticationType	Specifying the SSL Authentication Type	EFT Server 5.1
SetSSLKeyID	Specifying the SSL Key ID	EFT Server 5.1
SetTimeOut	Specifying the Timeout Value	All versions
SetUploadsPerSession	Specifying the Maximum Number of Uploads a User is Permitted per Session	All versions

Command Settings Interface Properties

Property	How It's Used	Applicable Version
Description	Retrieving or Changing the Description of a Custom Command	All versions
EnableProcessTimeOut	Enabling a Time Limit for a Custom Command	All versions
Executable	Retrieving or Changing the Path to the Executable of a Custom Command	All versions
IsEnabled	Enabling a Custom Command	All versions
MinNumOfParams	Requiring a Minimum Number of Parameters for Custom Commands	All versions
MinNumOfParamsMsg	Defining or Changing a Message for an Invalid Number of Command Parameters	All versions
Name	Retrieving or Changing the Name of a Custom Command	All versions
Parameters	Retrieving or Changing Custom Command Parameters	All versions
ProcessTimeOut	Specifying the Time Limit for a Custom Command	All versions
RedirectOutputToClient	Redirecting Command Output to Clients	All versions
RedirectOutputToLog	Redirecting Command Output to a Log	All versions
RequireParams	Viewing or Requiring Parameters for Custom Commands	All versions

Command Settings Interface Methods

Method	How It's Used	Applicable Version
AddUserPermission	Listing Users Allowed to Use a Command	All versions
GetUserPermissions	Retrieving a List of Users Allowed to Use a Custom Command	All versions
RemoveUserPermission	Prohibiting Users from Using a Custom Command	All versions

Command Action Parameters Interface Properties

Property	How it's used	Applicable Version
Command	Retrieving or Changing Command to Execute	EFT Server 5.2 and later
Parameters	Retrieving or Changing Parameters for Command	EFT Server 5.2 and later
WorkingFolder	Retrieving or Changing Working Folder for Command	EFT Server 5.2 and later

Certificate Information Interface Properties

Property	How It's Used	Applicable Version
Description	Retrieving a Certificate Description	All versions
ID	Retrieving a Certificate ID	All versions
IssuerCName	Retrieving a Certificate Issuer's Common Name	All versions
IssuerCountry	Retrieving a Certificate Issuer's Country	All versions
IssuerOneLine	Retrieving a Certificate Issuers Information	All versions
IssuerOrg	Retrieving a Certificate Issuer's Organization	All versions
IssuerUnit	Retrieving a Certificate Issuer's Unit	All versions
NotAfter	Retrieving a Certificate's Expiration Date	All versions
NotBefore	Retrieving a Certificate's Start Date	All versions
SubjectCName	Retrieving a Certificate Subject's Common Name	All versions
SubjectCountry	Retrieving Certificate Subject's Country	All versions
SubjectOneLine	Retrieving a Certificate Subject's Information	All versions
SubjectOrg	Retrieving a Certificate Subject's Organization	All versions
SubjectUnit	Retrieving a Certificate Subject's Unit	All versions

Mail Action Parameters Interface Properties

Property	How it's used	Applicable Version
TOAddresses	Retrieving or Changing Message Recipients	EFT Server 5.2 and later
CCAddresses		EFT Server 5.2 and later
BCCAddresses		EFT Server 5.2 and later
CopyToClient	Determining whether to CC Message to Client Associated with Event	EFT Server 5.2 and later
Subject	Retrieving or Changing Message Subject	EFT Server 5.2 and later
Body	Retrieving or Changing Message Body	EFT Server 5.2 and later

Cleanup Action Parameters Interface Properties

Property	How it's used	Applicable Version
DaysToKeepFiles	Retrieving or Changing the Period to Keep Files before Removing	EFT Server 5.2 and later
ExcludeFileMask	Specifying whether to Remove or Exclude Files from Cleanup	EFT Server 5.2 and later
FileMask	Retrieving or Changing Files to Remove	EFT Server 5.2 and later
Folder	Retrieving or Changing Folder to Cleanup	EFT Server 5.2 and later
Recursive	Specifying whether to Cleanup All Subfolders Recursively	EFT Server 5.2 and later

OpenPGP Action Interface Properties

Property	How it's used	Applicable Version
FilePath	Retrieving or Changing File Path for OpenPGP Event Action	EFT Server 5.2 and later
KeyIDs	Retrieving or Changing Keys to Encrypt/Decrypt Data	EFT Server 5.2 and later
Operation	Determining Operation for PGP Event Action	EFT Server 5.2 and later
PassPhrase	Retrieving or Changing the Passphrase for Signing or Decryption Key	EFT Server 5.2 and later
Sign	Determining whether to Sign Encrypted Data	EFT Server 5.2 and later
SignKeyID	Retrieving or Changing Key to Sign Encrypted Data	EFT Server 5.2 and later

Event Rule Interfaces

ActionStatement Interface Methods and Properties

Property	How it's used	Applicable Version
type	Action Statement Interface	EFT Server 5.2 and later
Action
FailSection

ActionStatements Interface Methods

Method	How it's used	Applicable Version
Add	Action Statements Interface	EFT Server 5.2 and later
Count
Delete
Item

CompoundCondition Interface Methods and Properties

Property	How it's used	Applicable Version
Operator	Compound Condition Interface	EFT Server 5.2 and later
Add
Count
Delete
Item

Download Action Parameters Interface (ICIDownloadActionParams)

Property	How it's used	Applicable Version
AutoLogin		EFT Server 5.25
DeleteSourceFile
Host
LocalPath
Password
Port
PrivateKeyPassword
PrivateKeyPath
Protocol
PublicKeyPath
RemotePath
User

Upload Action Parameters Interface (ICIUploadActionParams)

Property	How it's used	Applicable Version
AutoLogin		EFT Server 5.25
DeleteSourceFile
Host
LocalPath
Password
Port
PrivateKeyPassword
PrivateKeyPath
Protocol
PublicKeyPath
RemotePath
User

EventAction Interface Properties

Property	How it's used	Applicable Version
Params	Event Action Interface	EFT Server 5.2 and later
type	Event Action Interface	EFT Server 5.2 and later

EventActions Interface Methods

Method	How it's used	Applicable Version
Add	Event Actions Interface Methods	EFT Server 5.2 and later
Count
Delete
Item

EventRule Interface Methods and Properties

Property	How it's used	Applicable Version
Params	Event Rule Interface	EFT Server 5.2 and later
AddActionStatement
AddIfStatement
DeleteStatement
Statement
StatementsCount

EventRules Interface Methods

Method	How it's used	Applicable Version
Add	Event Rules Interface	EFT Server 5.2 and later
Count
Delete
Find
Item

EventRuleParams Interface Properties

Property	How it's used	Applicable Version
Description	Event Rule Parameters Interface	EFT Server 5.2 and later
Enabled
Name

FolderMonitorEventRuleParams Interface Properties

Property	How it's used	Applicable Version
CheckHealth	Folder Monitor Event Rule Parameters Interface	EFT Server 5.2 and later
CheckHealthInterval
Description
Enabled
ForcedlyDisabled		EFT Server 5.2.4 and prior
IncludeSubfolders		EFT Server 5.2 and later
Name
Path

IfStatement Interface Methods and Properties

Property	How it's used	Applicable Version
type	If Statement Interface	EFT Server 5.2 and later
Condition
ElseSection
IfSection

ReportActionParams Interface Properties

Property	How it's used	Applicable Version
CustomDate	Report Action Parameters Interface	EFT Server 5.2 and later
DateFormat
FilterAndOr
FilterField1
FilterField2
FilterOperator1
FilterOperator2
FilterValue1
FilterValue2
FromDate
Name
OptionalParameters
Path
ReportFileFormat
ToDate

SimpleCondition Interface Properties

Property	How it's used	Applicable Version
Not	Simple Condition Interface	EFT Server 5.2 and later
Operator
Property
Value

StopActionParams Interface Properties

Property

How it's used

Applicable Version

Action

Stop Action Parameters Interface

EFT Server 5.2 and later

Enabled

TransferActionParams Interface Properties (ICITransferActionParams)

Property	How it's used	Applicable Version
AutoLogin	Transfer Action Parameters Interface	EFT Server 5.2 and later
DeleteSourceFile		EFT Server 5.2.5 and later
Host		EFT Server 5.2 and later
Key		EFT Server 5.2 and later
KeyPass		EFT Server 5.2 and later
LocalPath		EFT Server 5.2 and later
Operation		EFT Server 5.2 and later
Password		EFT Server 5.2 and later
Port		EFT Server 5.2 and later
Protocol		EFT Server 5.2 and later
PubKey		EFT Server 5.2 and later
RemotePath		EFT Server 5.2 and later
User		EFT Server 5.2 and later

EventRuleStatement Interface Property

Property	How it's used	Applicable Version
type	Event Rule Statement Interface	EFT Server 5.2 and later

Enumerators and Constants

The following Enumerators and Constants are used in Event Rule Interfaces.

ConditionOperator

Constant	How it's used	Applicable Version
Contains	Contains (0x08) – Contains	EFT Server 5.2 and later
Equals	Equals (0x01) – Equals	EFT Server 5.2 and later
Less	Less (0x02) – Less	EFT Server 5.2 and later
LessOrEquals	LessOrEquals (0x04) – Less or equal	EFT Server 5.2 and later
Match	Match (0x10) – Match (for file name matching with template such as *.exe)	EFT Server 5.2 and later
MemberOf	MemberOf (0x20) – Member of	EFT Server 5.2 and later
OneOf	OneOf (0x40) – One of	EFT Server 5.2 and later
StartsWith	StartsWith (0x80) – Starts with	EFT Server 5.2 and later

EventActionType

Constant	How it's used	Applicable Version
CleanupAction	CleanupAction (0x80) – Cleanup in folder	EFT Server 5.2 and later
CommandAction	CommandAction (0x01) – Execute command	EFT Server 5.2 and later
DownloadAction	DownloadAction (0x08) – Download file	EFT Server 5.2 and later
MailAction	MailAction (0x02) – Send E-mail	EFT Server 5.2 and later
PGPAction	PGPAction (0x20) – PGP action	EFT Server 5.2 and later
ReportAction	ReportAction (0x100) – Generate report	EFT Server 5.2 and later
StopAction	StopAction (0x40) – Stop rule execution	EFT Server 5.2 and later
UploadAction	UploadAction - Upload file	EFT Server 5.2.5 and later

Event Properties

The following properties are used in the Event Rule interfaces.

Category	Property	How it's used	Applicable Version
General properties:	Time (1) – Current time	Event Properties	EFT Server 5.2 and later
	Name (2) – Event name
	Reason (3) – Event reason
	TimeStamp (4) – Current time
	DateStamp (5) – Current date
	MonitorFolderStatus (6) – Folder monitoring status
	EventName (7) – Event name
Server Properties:	ServerRunning (1000) – Whether server is running	Event Properties	EFT Server 5.2 and later
	ServerLogOldName (1001) – Old log file name
	ServerLogNewName (1002) – New log file name
	ServerLogOldPath (1003) – Old log file path
	ServerLogNewPath (1004) – New log file path
	ServerLogTime (1005) – Log type
	ServerLogFolder (1006) – Log folder
	ServerServerNodeName (1007) – Name of the node server is running on
Site Properties:	SiteRunning (2000) – Whether site is started	Event Properties	EFT Server 5.2 and later
	SiteName (2001) – Site name
	SiteAccountManagementURL (2002) – PCI account management URL
Connection Properties:	LocalIP (3000) – Server IP	Event Properties	EFT Server 5.2 and later
	RemoteIP (3001) – Remote peer IP
	LocalPort (3002) – Server port
	RemotePort (3003) – Remote peer port
	Protocol (3004) – Connection protocol
	WebTransferClientConnection (3005) – Web-Transfer Client connection
Client Properties:	ClientLogin (4000) – Client’s login name	Event Properties	EFT Server 5.2 and later
	ClientPassword (4001) – Client’s password
	ClientAccessGroup (4002) – Whether client belongs to one of the permission groups
	ClientEnabled (4003) – Is client’s account enabled
	ClientSettingsLevel (4004) – Client’s settings template
	ClientFullName (4005) – Client’s full name
	ClientDescription (4006 ) – Client’s description
	ClientComment (4007) – Comment to client’s account
	ClientEMail (4008) – Client’s e-mail
	ClientPhone (4009) – Client’s phone number
	ClientPager (4010) – Client’s pager
	ClientFax (4011) – Client’s fax
	ClientHomeFolder (4012) – Client’s home folder
	ClientHomeFolderIsRoot (4013) – Is client’s home folder root for them
	ClientQuotaMax (4014) – Client’s disk quota (max)
	ClientQuotaUsed (4015) – Client’s disk quota (currently used)
	ClientInvalidLoginAttempts (4016) – Client’s invalid login attempt count
	ClientCanChangePassword (4017) – Has client permission to change their password
	ClientIP (4018) – Client’s IP
	ClientSSLAllowed (4019) – Has client permission to use SSL encryption
	ClientFTPAllowed (4020) – Has client permission to connect via FTP
	ClientSFTPAllowed (4021) – Has client permission to connect via SFTP
	CClientLastLogin (4022) – Client’s last login timestamp
	ClientPasswordExpiration (4023) – Client’s password expiration date
	ClientMustResetPasswordAtFirstLogin (4024) – Must client change their password oninitial login.
	ClientAccountExpirationDate (4025) – Client’s account expiration date
	ClientAccountLocked (4026) – Is client’s account locked out
	ClientCustomField1 (4027) – Client’s account custom field #1
	ClientCustomField2 (4028) – Client’s account custom field #2
	ClientCustomField3 (4029) – Client’s account custom field #3
File System Properties:	VirtualPath (5000) – File virtual path	Event Properties	EFT Server 5.2 and later
	PhysicalPath (5001) – File physical path
	DestinationVirtualPath (5002) – Destination file virtual path
	DestinationPhysicalPath (5003) – Destination file physical path
	FolderName (5004) – Folder
	FileName (5005) – File name
	DestinationFolderName (5006) – Destination folder
	DestinationFileName (5007) – Destination file name
	FolderOperation (5008) – Folder operation
	FileCreationDate (5009) – File creation date
	FileCreationTime (5010) – File creation time
	FileSize (5011) – File size
	FileCRC (5012) – File CRC
	ReportPath (5013) – Report file path
	ReportContent (5014) – Report content
	ReportFileName (5015) – Report file name

EventRuleStatementType

Constant	How it's used	Applicable Version
ActionStatement	ActionStatement (0) – Action statement	EFT Server 5.2 and later
IfStatement	IfStatement (1) – Conditional statement	EFT Server 5.2 and later

Event Type

Category	Event	How it's used	Applicable Version
Server Events:	MonitorFolder	Enumerators and Constants	EFT Server 5.2 and later
	OnMonitorFolderFailed
	OnLogRotate
	OnServiceStarted
	OnServiceStopped
	OnTimer
Site Events:	OnSiteStarted	Enumerators and Constants	EFT Server 5.2 and later
	OnSiteStopped	Enumerators and Constants	EFT Server 5.2 and later
Connection Events:	OnClientConnected	Enumerators and Constants	EFT Server 5.2 and later
	OnClientConnectonFailed
	OnClientDisconnected
Client Events:	OnClientCreated	Enumerators and Constants	EFT Server 5.2 and later
	OnClientDisabled
	OnClientQuotaExceeded
	OnClientLoggedOut
	OnClientLoggedIn
	OnClientLoginFailed
	OnClientPasswordChanged
File System Events:	BeforeFileDownload	Enumerators and Constants	EFT Server 5.2 and later
	OnChangeFolder
	OnFileDeleted
	OnFileDownloaded
	OnDownloadFailed
	OnFileMoved
	OnFileRenamed
	OnFileUploaded
	OnFolderCreated
	OnFolderDeleted
	OnUploadFailed
	OnVerifiedUploadSuccess
	OnVerifiedUploadFailure
	OnVerifiedDownloadSuccess
	OnVerifiedDownloadFailure

LogicalOperator

Constant	How it's used	Applicable Version
LogicalAnd	LogicalOr (0) – OR	EFT Server 5.2 and later
LogicalOr	LogicalAnd (1) – AND	EFT Server 5.2 and later

Network Protocol

Constant	How it's used	Applicable Version
ProtocolFTP		EFT Server 5.2.5
ProtocolFTPS		EFT Server 5.2.5
ProtocolFTPSAuthTLS		EFT Server 5.2.5
ProtocolFTPSExpl		EFT Server 5.2.5
ProtocolHTTP		EFT Server 5.2.5
ProtocolHTTPS		EFT Server 5.2.5
ProtocolLocal		EFT Server 5.2.5
ProtocolSFTP		EFT Server 5.2.5

PGP Operation

Constant	How it's used	Applicable Version
Encrypt	Determining Operation for PGP Event Action (Operation)	EFT Server 5.2 and later
Decrypt	Determining Operation for PGP Event Action (Operation)	EFT Server 5.2 and later

Recurrence

Constant	How it's used	Applicable Version
Custom	Custom (0) – Hourly	EFT Server 5.2 and later
Daily	Daily (1) – Daily	EFT Server 5.2 and later
Weekly	Weekly (2) – Weekly	EFT Server 5.2 and later
Monthly	Monthly (3) – Monthly	EFT Server 5.2 and later
Yearly	Yearly (4) – Yearly	EFT Server 5.2 and later
OneTime	OneTime (5) – Trigger only once	EFT Server 5.2 and later

SFTP AdvBool

Constant	How it's used	Applicable Version
abFalse	(0)	EFT Server 5.2 and later
abTrue	(1)	EFT Server 5.2 and later
abInherited	(2)	EFT Server 5.2 and later

StopType

Constant	How it's used	Applicable Version
StopRule	(2)	EFT Server 5.2.5
StopEvent	(4)	EFT Server 5.2.5
StopeRuleEvent	(6)	EFT Server 5.2.5

Did this topic solve your problem/answer your question?

- For the most up-to-date information regarding EFT Server and its modules;

- To view version history, updates, and activation instructions;

- To download a PDF of this user guide;

- And to search the Knowledge Base and User Forum,

Visit the GlobalSCAPE Support Center, http://www.globalscape.com/support .

Last modified: May 5, 2009