List of Interfaces, Methods, and Properties

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

The interfaces are listed alphabetically below. For an alphabetized list of each property and method, refer to the Index.

List of Interfaces  Show

Action Statement Interface (ICIActionStatement)

The Action Statement interface members are listed below. For details of how to use them in scripts, refer to Action Statement Interface.

Members

Applicable Version

type

EFT Server v5.2 and later

Action

FailSection

Action Statements Interface (ICIActionStatements)

The Action Statements interface members are listed below. For details of how to use them in scripts, refer to Action Statements Interface.

Members

Applicable Version

Add

EFT Server v5.2 and later

Count

EFT Server v5.2 and later

Delete

EFT Server v5.2 and later

Item

EFT Server v5.2 and later

AS2 Send Action Parameters Interface (ICIAS2SendActionParams)

The AS2 Send Action Parameters interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.

Members

How it's used

Applicable Version

AS2ID

Specifying or Retrieving the AS2 ID of File Sender

EFT Server v6.1 and later

AsyncReceiptTimeoutMin

Specifying or Retrieving Maximum Wait Time for Asynchronous AS2 Receipt

EFT Server v6.1 and later

ClientProfile

Specifying or Retrieving Username whose AS2 Outbound Profile is Used for this AS2 Send Operation

EFT Server v6.1 and later

Compress

Specifying or Retrieving whether AS2 File will be Compressed before Sending

EFT Server v6.1 and later

ContentType

Specifying or Retrieving the Type of AS2 File to Send

EFT Server v6.1 and later

DeleteSourceFile

Specifying or Retrieving whether Source File will be Removed after Successful Delivery

EFT Server v6.1 and later

Encrypt

Specifying or Retrieving whether AS2 Message will be Encrypted with AS2 Partner Certificate

EFT Server v6.1 and later

Host

Specifying or Retrieving the Remote Host to which to Send the AS2 File

EFT Server v6.1 and later

LocalPath

Specifying or Retrieving the Path to the File to Send

EFT Server v6.1 and later

PartnerAS2ID

Specifying or Retrieving the AS2 ID of the AS2 Partner to which you are Send an AS2 File

EFT Server v6.1 and later

PartnerCertificatePath

Specifying or Retrieving Path to AS2 Partner Certificate

EFT Server v6.1 and later

Password

Specifying or Retrieving Authentication Password for Authentication on the AS2 Server

EFT Server v6.1 and later

Port

Specifying or Retrieving the Remote Port to Send the AS2 File

EFT Server v6.1 and later

ReceiptDelivery

Specifying or Retrieving Mechanism of Receipt Delivery Required for AS2 Message

EFT Server v6.1 and later

ReceiptPolicy

Specifying or Retrieving Type of Receipt Required for AS2 Message

EFT Server v6.1 and later

RemotePath

Specifying or Retrieving the Path on AS2 Server to Send AS2 File

EFT Server v6.1 and later

RetriesCount

Specifying or Retrieving the Maximum Amount of Sending Retries in the Case of Failure

EFT Server v6.1 and later

RetryDelaySec

Specifying or Retrieving the Interval between Sending Retries

EFT Server v6.1 and later

Sign

Specifying or Retrieving whether AS2 Message will be Signed with Site Certificate

EFT Server v6.1 and later

Subject

Specifying or Retrieving AS2 Message Subject

EFT Server v6.1 and later

TimeoutSec

Specifying or Retrieving the Timeout while Sending AS2 File

EFT Server v6.1 and later

UseClientProfile

Specifying or Retrieving whether a Certain AS2 Outbound Profile is to be Used

EFT Server v6.1 and later

User

Specifying or Retrieving Username for Authentication on AS2 Server

EFT Server v6.1 and later

Audit Interface (ICIAudit) -- Auditing the SAT Module

The Audit interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.

Members

How It's Used

Applicable Version

AuditSATEmail

Auditing a SAT E-mail in ARM

EFT Server v6.0 and later

AuditSATFile

Auditing a SAT File in ARM

EFT Server v6.0 and later

AuditSATTransaction

Auditing a SAT Transaction in ARM

EFT Server v6.0 and later

Automated Workflow Task Event Action Parameters Interface (ICIAWTaskActionParams)

The Automated Workflow Task Event Action Parameters interface members is listed below. For details of how to use it in scripts, refer to Automated Workflow Task Event Action Parameters Interface.

Members

Applicable Version

TaskName

EFT Server v6.1 and later

Backup Action Parameters Interface (ICIBackupActionParams)

The Backup Action Parameters members is listed below. For details of how to use it in scripts, refer to Backup Action Parameters.

Members

Applicable Version

Folder

EFT Server v6.1 and later

Certificate Information Interface (ICICertInfo)

The Certificate Information interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.

Members

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

Cleanup Action Parameters Interface (ICICleanupActionParams)

The Cleanup Action Parameters interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.

Members

How it's used

Applicable Version

DaysToKeepFiles

Retrieving or Changing the Period to Keep Files before Removing

EFT Server v5.2 and later

ExcludeFileMask

Specifying whether to Remove or Exclude Files from Cleanup

EFT Server v5.2 and later

FileMask

Retrieving or Changing Files to Remove

EFT Server v5.2 and later

Folder

Retrieving or Changing Folder to Cleanup

EFT Server v5.2 and later

Recursive

Specifying whether to Cleanup All Subfolders Recursively

EFT Server v5.2 and later

Client Settings Interface Methods and Properties (ICIClientSettings)

The Client Settings interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.

Members

How It's Used

Applicable Version

AddIPAccessRule

Adding an IP Access IP Mask for a Client

EFT Server v5.1.1 and later

Comment

Viewing User Properties - Comments

All versions

Custom1, Custom2, Custom3

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

ForcePasswordChange

Forcing a User to Change Password on Login

EFT Server v6.0  and later

FullName

Viewing User Properties - Full Name

All versions

GetAllowAnyPwd

Determining if Users Can Create Any Password

EFT Server v6.0.1 and earlier

GetAllowedMasks

Retrieving Allowed IP Masks for a User

EFT Server v5.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

EFT Server v6.0.1 and earlier

GetAppletEnabled

Determining Web Transfer Client Access

EFT Server v3.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 v4.3.4 and EFT Server v5.1

GetDeniedMasks

Retrieving Denied IP Mask for a User

EFT Server v5.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 v4.3.4 and later

GetForcePasswordResetOnInitialLogin

Determining whether Force Password Reset is On

EFT Server v6.2 and later

GetFTPS

Viewing if FTPS is Enabled for a Client

EFT Server v6.0 and later

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

EFT Server v6.0.x and earlier

GetHomeIPString

Retrieving Users' Home IP Address

EFT Server v6.0.x and earlier

GetHTTPS

Viewing if HTTPS is Enabled for a Client

EFT Server v6.0 and later

GetIncorrectPasswordAttempts

Determining the Number of Failed Password Attempts

All versions

GetLimitAccessByIP

Retrieving Allowed IP Address

EFT Server v6.1 and later

GetLimitLoginAttempts

Retrieving Number of Login Attempts Allowed

EFT Server v5.1.1 and later

GetLockoutNotDisable

Viewing Whether Account Lockout is Enabled for a User

EFT Server v5.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

EFT Server v5.2 and earlier

GetSSLAuthenticationType

Identifying the SSL Authentication Type

EFT Server v5.1 and later

GetSSLKeyID

Identifying the SSL Key ID

EFT Server v5.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

InvalidAttemptsPeriod

Viewing Invalid Attempts Period for a User

EFT Server v5.1.1 and later

IPAccessAllowedDefault

IP addresses with which a user is allowed to connect to the Server

EFT Server v5.1.1 and later

IsActivityPeriodLimited

Determining whether a User Account's Inactivity Period is Limited

EFT Server v6.1 and later

IsPasswordAgeLimited

Determining if or when Account Password is to Expire

EFT Server v6.1 and later

LockoutPeriod

Viewing a User's Lockout Period

EFT Server v5.1.1 and later

MaxInvalidLoginAttempts

Viewing the Number of Invalid Login Attempts Allowed for a Client

EFT Server v5.1.1 and later

Pager

Viewing User Properties - Pager

All versions

Phone

Viewing User Properties - Phone

All versions

RemoveIPAccessRule

Removing an IP Access Mask for User

EFT Server v5.1.1 and later

SetAllowAnyPwd

Allowing Users to Create Any Password

EFT Server v6.0.1 and earlier

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

EFT Server v6.0.1 and earlier

SetAppletEnabled

Specifying Web Transfer Client Access

EFT Server v3.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 v4.3.4 and EFT Server v5.1 and later

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

SetForcePasswordResetOnInitialLogin

Determining whether Force Password Reset is On

EFT Server v6.2 and later

SetFTPS

Allowing FTPS Access for a Client (SetFTPS)

EFT Server v6.x and later

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

EFT Server v6.0.x and earlier

SetHomeIPString

Setting Users' Home IP Address

EFT Server v6.0.x and earlier

SetHTTPS

Allowing Users to Connect over HTTPS (SetHTTPS)

EFT Server v6.x and later

SetIncorrectPasswordAttempts

Specifying the Number of Incorrect Password Attempts

All versions prior to 6.1

SetLimitAccessByIP

Setting Allowed IP Address

EFT Server v6.1 and later

SetLimitLoginAttempts

Specifying Number of Login Attempts Allowed

EFT Server v5.1.1 and later

SetLockoutNotDisable

Enabling Account Lockout for a User

EFT Server v5.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

EFT Server v5.2 and earlier

SetSSLAuthenticationType

Specifying the SSL Authentication Type

EFT Server v5.1 and later

SetSSLKeyID

Specifying the SSL Key ID

EFT Server v5.1 and later

SetTimeOut

Specifying the Timeout Value

All versions

SetUploadsPerSession

Specifying the Maximum Number of Uploads a User is Permitted per Session

All versions

Command Action Parameters Interface (ICICommandActionParams)

The Command Action Parameters interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.

Members

How it's used

Applicable Version

Command

Retrieving or Changing Command to Execute

EFT Server v5.2 and later

Parameters

Retrieving or Changing Parameters for Command

EFT Server v5.2 and later

WorkingFolder

Retrieving or Changing Working Folder for Command

EFT Server v5.2 and later

Command Settings Interface (ICICommandSettings)

The Command Settings interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.

Members

How It's Used

Applicable Version

AddUserPermission

Listing Users Allowed to Use a Command

All versions

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

GetUserPermissions

Retrieving a List of Users Allowed to Use a Custom Command

All versions

IsEnabled

Enabling a Custom Command

All versions

LogPath

Specifying or Retrieving the Command Log Path

EFT Server v6.1 and later

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

RemoveUserPermission

Prohibiting Users from Using a Custom Command

All versions

RequireParams

Viewing or Requiring Parameters for Custom Commands

All versions

Compound Condition Interface (ICICompoundCondition)

The Compound Condition interface members are listed below. For details of how to use them in scripts, refer to Compound Condition Interface.

Members

Applicable Version

Add

EFT Server v5.2 and later

Count

EFT Server v5.2 and later

Delete

EFT Server v5.2 and later

Item

EFT Server v5.2 and later

Operator

EFT Server v5.2 and later

Download Action Parameters Interface (ICIDownloadActionParams)

The Download Action Parameters interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.

Members

How it's used

Applicable Version

AutoLogin

Download Action Parameters Interface Properties

EFT Server v5.25 and later

ConnectionRetryAttempts

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.2.10 and later

ConnectionTimeoutSeconds

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.2.10 and later

DeleteSourceFile

Download Action Parameters Interface Properties

EFT Server v5.25 and later

FTPDataConnectionMode

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.2.10 and later

FTPDataConnectionPortMax

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.2.10 and later

FTPDataConnectionPortMin

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.2.10 and later

FTPSClearCommandChannel

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.2.10 and later

FTPSClearDataChannel

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.2.10 and later

Host

Download Action Parameters Interface Properties

EFT Server v5.25 and later

LocalPath

Download Action Parameters Interface Properties

EFT Server v5.25 and later

MaxConcurrentThreads

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.210 and later

Password

Download Action Parameters Interface Properties

EFT Server v5.25 and later

Port

Download Action Parameters Interface Properties

EFT Server v5.25 and later

PreserveFileTime

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.2.10 and later

PrivateKeyPassword

Download Action Parameters Interface Properties

EFT Server v5.25 and later

PrivateKeyPath

Download Action Parameters Interface Properties

EFT Server v5.25 and later

Protocol

Download Action Parameters Interface Properties

EFT Server v5.25 and later

PublicKeyPath

Download Action Parameters Interface Properties

EFT Server v5.25 and later

RemotePath

Download Action Parameters Interface Properties

EFT Server v5.25 and later

RetryDelaySeconds

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.2.10 and later

TextFileTypes

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.2.10 and later

User

Download Action Parameters Interface Properties

EFT Server v5.25 and later

ValidateIntegrity

Specifying Advanced Options for Transfer Action Parameters

EFT Server v6.2.10 and later

Event Action Interface (ICIEventAction)

The Event Action interface members are listed below. For details of how to use them in scripts, refer to Event Action Interface.

Members

Applicable Version

GetParams

EFT Server v6.1 and later

Params

EFT Server v5.2 - 6.0.x

SetParams

EFT Server v6.1 and later

type

EFT Server v5.2 - 6.0.x

Event Actions Interface (ICIEventActions)

The Event Actions interface members are listed below. For details of how to use them in scripts, refer to Event Actions Interface Methods.

Members

Applicable Version

Add

EFT Server v5.2 and later

Count

 

Delete

 

Item

 

Event Information Interface (ICIEventInfo)

The Event Information interface members are listed below. For details of how to use them in scripts, refer to Event Information Interface.

Members

Applicable Version

Name

EFT Server v6.1 and later

Type

 

Event Rule Interface (ICIEventRule)

The Event Rule Interface members are listed below. For details of how to use them in scripts, refer to Event Rule Interface.

Members

Applicable Version

AddActionStatement

EFT Server v5.2 and later

AddIfStatement

EFT Server v5.2 and later

DeleteStatement

EFT Server v5.2 and later

GetParams

EFT Server v6.2 and later

Set Params

EFT Server v6.2 and later

Params

EFT Server v5.2 - 6.1.x

Statement

EFT Server v5.2 and later

StatementsCount

EFT Server v5.2 and later

Event Rule Parameters Interface (ICIEventRuleParams)

The Event Rule Parameters interface members are listed below. For details of how to use them in scripts, refer to Event Rule Parameters Interface.

Members

Applicable Version

Description

EFT Server v5.2 and later

Enabled

 

Name

 

Event Rules Interface (ICIEventRules)

The Event Rules interface members are listed below. For details of how to use them in scripts, refer to Event Rules Interface.

Members

Applicable Version

Add

EFT Server v5.2 and later

Count

 

Delete

 

Find

 

Item

 

Folder Monitor Event Rule Parameters Interface (ICIFolderMonitorEventRuleParams)

The Folder Monitor Event Rule Parameters members are listed below. For details of how to use them in scripts, refer to Folder Monitor Event Rule Parameters Interface.

Members

Applicable Version

CheckHealth

EFT Server v5.2 and later

CheckHealthInterval

EFT Server v5.2 and later

Description

EFT Server v5.2 and later

Enabled

EFT Server v5.2 and later

ForcedlyDisabled  

EFT Server v5.2.4 and prior

IncludeSubfolders

EFT Server v5.2 and later

Name

EFT Server v5.2 and later

Path

EFT Server v5.2 and later

If Statement Interface (ICIIfStatement )

The If Statement Interface members are listed below. For details of how to use them in scripts, refer to If Statement Interface.

Members

Applicable Version

Condition

EFT Server v5.2 and later

ElseSection

EFT Server v5.2 and later

IfSection

EFT Server v5.2 and later

type

EFT Server v5.2 and later

Mail Action Parameters Interface (ICIMailActionParams)

The Mail Action Parameters interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table.

Members

How it's used

Applicable Version

CCAddresses

Retrieving or Changing Message Recipients

EFT Server v5.2 and later

BCCAddresses

Retrieving or Changing Message Recipients

EFT Server v5.2 and later

Body

Retrieving or Changing Message Body

EFT Server v5.2 and later

CopyToClient

Determining whether to CC Message to Client Associated with Event

EFT Server v5.2 and later

Subject

Retrieving or Changing Message Subject

EFT Server v5.2 and later

TOAddresses

Retrieving or Changing Message Recipients

EFT Server v5.2 and later

OpenPGP Action Parameters Interface (ICIPGPActionParams)

The OpenPGP Action Parameters interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table.

Members

How it's used

Applicable Version

ASCIIArmoredOutput

Specifying or Retrieving PGP Action Output Encoded in Text Format

EFT Server v6.1 and later

CompressionLevel

Specifying or Retrieving Compression Level for PGP Encryption Operation

EFT Server v6.1 and later

FilePath

Retrieving or Changing File Path for OpenPGP Event Action

EFT Server v5.2 and later

KeyIDs

Retrieving or Changing Keys to Encrypt/Decrypt Data

EFT Server v5.2 and later

Operation

Determining Operation for PGP Event Action

EFT Server v5.2 and later

PassPhrase

Retrieving or Changing the Passphrase for Signing or Decryption Key

EFT Server v5.2 and later

SDAPassword

Specifying or Retrieving Password for SDA Operation

EFT Server v6.1 and later

Sign

Determining whether to Sign Encrypted Data

EFT Server v5.2 - 6.0.x

SignatureInSeparateFile

Specifying or Retrieving whether Signature will be Placed in Separate File

EFT Server v6.1 and later

SigningHash

Specifying or Retrieving Hash Algorithm for Signing

EFT Server v6.1 and later

SignKeyID

Retrieving or Changing Key to Sign Encrypted Data

EFT Server v5.2 and later

OpenPGP Key Information Interface (ICIPGPKeyInfo)

The OpenPGP Key Information interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table.

Members

Applicable Version

CreationDate

EFT Server v6.1 and later

Description

EFT Server v6.1 and later

ExpirationDate

EFT Server v6.1 and later

ID

EFT Server v6.1 and later

Name

EFT Server v6.1 and later

NeverExpires

EFT Server v6.1 and later

Private

EFT Server v6.1 and later

Size

EFT Server v6.1 and later

Permission Interface (ICIPermission)

The Permission interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.

Members

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

Report Action Parameters Interface (ICIReportActionParams)

The Report Action Parameters members are listed below. For details of how to use the properties in scripts, refer to Report Action Parameters Interface.

Members

Applicable Version

CustomDate

EFT Server v5.2 and later

DateFormat

EFT Server v5.2 and later

FilterAndOr

EFT Server v5.2 and later

FilterField1

EFT Server v5.2 and later

FilterField2

EFT Server v5.2 and later

FilterOperator1

EFT Server v5.2 and later

FilterOperator2

EFT Server v5.2 and later

FilterValue1

EFT Server v5.2 and later

FilterValue2

EFT Server v5.2 and later

FromDate

EFT Server v5.2 and later

Name

EFT Server v5.2 - 6.0.x (This information now can be set/retrieved via ICIReportInfo::Name.)

OptionalParameters

EFT Server v5.2 and later

Path

EFT Server v5.2 - 6.0.x (This information now can be set/retrieved via ICIReportInfo::DefinitionPath.)

Report

EFT Server v6.1 and later

ReportFileFormat

EFT Server v5.2 and later

ToDate

EFT Server v5.2 and later

Report Information Interface Properties (ICIReportInfo)

The Report Information interface members are listed below. For details of how to use them in scripts, refer to Report Information Interface.

Members

Applicable Version

Name

EFT Server v6.1 and later

DefinitionPath

Server Interface (ICIServer)

The Server interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table below.

Members

How It's Used

Applicable Version

AddIPAccessRule

Adding an IP Mask

All versions

AdminPort

Editing the Administrator Port

All versions

AllowClearCommandChannel

Allowing a Clear Command Channel on the Server

EFT Server v5.0.1 and later

AllowRemoteAdministration

Allowing Remote Administration

All versions

AllowUnprotectedDataChannel

Allowing an Unprotected Data Channel on the Server

EFT Server v5.0.1 and later

ApplyChanges

Applying Changes to the Server

Versions prior to EFT Server v5.0

AreLingeringTransactions

Determining if Lingering Transactions Exist

EFT Server v5.2 to 6.0.x

ARMDatabaseName

Editing the ARM Database Name

All versions

ARMPassword

Editing the ARM Password

All versions

ARMServerName

Editing the ARM Server Name

All versions

ARMUserName

Editing the ARM Username

All versions

Auditor

Retrieving the Audit Interface (Auditor)

EFT Server v6.0 and later

AutoSave

AutoSave Property

EFT Server v6.2.18 and later

AvailableEvents

Retrieving a List of Available Events

EFT Server v6.1 and later

AvailablePGPKeys

Retrieving a List of EFT Server's PGP Keys

EFT Server v6.1 and later

AvailableReports

Retrieving a List of Available Reports

EFT Server v6.1 and later

AvailableSSHKeys

Retrieving List of Available SSH Keys

EFT Server v6.1 and later

CertificateFilePath

Editing the File Path for Certificates

All versions

ChangeAdminPassword

Changing the Administrator Password

EFT Server 4.3.4 and later

CipherList

Editing the Cipher List

EFT Server v5.0.1 and later

Close

Closing the Administrator Connection to the Server

All versions

Connect

Connecting to the Server as an Administrator

All versions

ConnectedUsersNumber

Retrieving the Number of Connected Users

EFT Server 3.5.1 and later

ConnectEx

Logging in to EFT Server Using IWA or Windows Account

EFT Server v6.2 and later

EnableARM

Enabling Auditing and Reporting

All versions

GenerateReport

Generating an EFT Server Report

EFT Server v6.1 and later

GetAdminIPs

Retrieving a List of Administrator IP Addresses

EFT Server v4.3.4 and later

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 v4.3.4 and later

ImportSSHKey

Importing an SSH Public Key

EFT Server v6.1 and later

IPAccessAllowedDefault

Finding or Setting the Default IP Access Mode

All versions

IsDBConnected

Determining if Server is Connected to the ARM Database

EFT Server v5.2 - 6.0.x

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

ModuleRegistrationState

Retrieving the Registration status of an EFT Server Module

EFT Server v6.1 and later

PassPhrase

Editing Private Key Passphrases

All versions

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 and later

RemoveSSHKey

Removing an SSH Public Key from EFT Server

EFT Server v6.1 and later

SetSSLCertificate

Specifying SSL Certificate for Administrator Connections

EFT Server v6.1 and later

Sites

Retrieving a List of Server Sites

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 v5.0.1 and later

UseSSLForAdministration

Requiring SSL for Remote Administration

All versions

Simple Condition Interface (ICISimpleCondition)

The Simple Condition Interface members are listed below. For details of how to use the properties in scripts, refer to Simple Condition Interface.

Members

Applicable Version

Not

EFT Server v5.2 and later

Operator

EFT Server v5.2 and later

Property

EFT Server v5.2 and later

Value

EFT Server v5.2 and later

Site Interface (ICISite)

The Site Interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table below.

Members

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

AllowChangePassword

Retrieving or Specifying if Site Users are Allowed to Change Password

EFT Server v6.2 and later

AssignEventRuleCustomCommandWorkingFolder

Assigning the Event Rule Custom Command Working Folder

EFT Server v4.3.4 and later

AssignFullPermissionsForHomeFolder

Setting the Grant Full Permissions Option

All versions

AutoBanIPsPermanently

Banning IP Addresses

All versions

AutobanSensitivity

Retrieving or Specifying the Auto-Ban Sensitivity

EFT Server version 6.1 and later

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

CancelTransfer

Cancelling an HTTPS Transfer

EFT Server v4.3.4 and later

ChangeUserPassword

Changing a User's Password

All versions

ConnectMessage

Editing the Server Connection Message

All versions

CreateCommand

Creating a New Custom Command

All versions

CreateComplexPassword

Creating a Complex Password for a User

EFT Server v5.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

DisableSFTP

Enabling or Disabling SFTP on a Site

EFT Server v6.1 and later

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

EnableSFTP

Enabling or Disabling SFTP on a Site

EFT Server v6.1 and later

EventRules

Retrieving a List of Event Rules

EFT Server v5.2 and later

ExitMessage

Managing a Site's Exit Message

All versions

ExportTrustedCertificate

Retrieving a Certificate's Data String

All versions

ForcePasswordResetOnInitialLogin

Determining whether Force Password Reset is On

EFT Server v6.2 and later

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 v4.3.4 and later

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 v4.3.4 and later

GetHTTPPort

Retrieving the HTTP Port for a Site

EFT Server v4.3.4 and later

GetHTTPSAccess

Verifying if HTTPS is Enabled for a Site

EFT Server v4.3.4 and later

GetHTTPSPort

Retrieving the HTTPS Port for a Site

EFT Server v4.3.4 and later

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 v5.2.5 and later

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 v4.3.4 and later

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

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

ImportTrustedCertificate

Saving a Trusted Certificate to a File

All versions

InvalidAttemptsPeriod

Viewing Invalid Attempts Period for a Site

EFT Server v5.1.1 and later

IPAccessAllowedDefault

Setting IP Addresses that have Access to a Site

All versions

IsFolderInherited

Retrieving Whether a Folder is Virtual or Physical and Whether Folder is Inherited

EFT Server v6.2.18 and later

IsFolderVirtual

Retrieving Whether a Folder is Virtual or Physical and Whether Folder is Inherited

EFT Server v6.2.18 and later

IsStarted

Determining if a Site is Started

All versions

KickUser

Forcing a User to Log Off of the Site

EFT Server v4.3.4 and later

LimitLoginAttempts

Enabling Allowed Login Attempt Limit

EFT Server v5.1.1 and later

LockoutNotDisable

Enabling Account Lockout

EFT Server v5.1.1 and later

LockoutPeriod

Viewing the Lockout Period for a Site

EFT Server v5.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 v5.1.1 and later

MaxTransferSpeed

Retrieving or Setting Maximum Transfer Speed

All versions

MoveUserToSettingsLevel

Moving a User to a User Settings Level

All versions

Name

Retrieving a Site's Name

All versions

ODBCSettings

Retrieving ARM ODBC Settings

EFT Server v4.3.4 and later

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

RemapVirtualFolder

Remapping a Virtual Folder Path

EFT Server v4.3.4 and later

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 v4.3.4 and later

SetHTTPPort

Specifying the HTTP Port

EFT Server v4.3.4 and later

SetHTTPSAccess

Enabling HTTPS Access

EFT Server v4.3.4 and later

SetHTTPSPort

Specifying the HTTPS Port

EFT Server v4.3.4 and later

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 and later

SetSSLAuth

Allowing Explicit SSL Access to a Site

All versions

Sub SetSSLCertificate

Specifying the SSL Certificate for a Site (SetSSLCertificate)

EFT Server 6.1 and later

SetSSLImp

Allowing Implicit SSL Access to a Site

All versions

Start

Starting a Site

All versions

Stop

Stopping Site

All versions

UserLimitMessage

Managing the User Limit Message

All versions

ValidatePassword

Validating a User's Password

EFT Server v3.5.1 and later

VFSFilter

Retrieving and Modifying a List of Banned File Types

All versions

Sites Interface Methods (ICISites)

The Sites Interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table below.

Members

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 v4.3.4 and later

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

SSH Key Information Interface Properties (ICISSHKeyInfo)

The SSH Key Information interface members are listed below. For details of how to use them in scripts, refer to SSH Key Information Interface.

Members

Applicable Version

ID

EFT Server v6.1 and later

Name

EFT Server v6.1 and late

Fingerprint

EFT Server v6.1 and late

Stop Action Parameters Interface (ICIStopActionParams)

The Stop Action Parameters interface members are listed below. For details of how to use the properties in scripts, refer to Stop Action Parameters Interface.

Members

Applicable Version

Action

EFT Server v5.2 and later

Enabled

EFT Server v5.2 and later

Timer Event Rule Parameters Interface (ICITimerEventRuleParams)

The Timer Event Rule Parameters interface members are listed below. For details of how to use the properties in scripts, refer to Timer Event Rule Parameters Interface.

Members

Applicable Version

CustomPeriod

EFT Server v5.2

DayIndex

EFT Server v5.2

DayOfMonth

EFT Server v5.2

DayPeriod

EFT Server v5.2

Enabled

EFT Server v5.2 and later

FixedDate

EFT Server v5.2

LastPremature

EFT Server v5.2 and later

LastTime

EFT Server v5.2 and later

MonthIndex

EFT Server v5.2

MonthPeriod

EFT Server v5.2

Name

EFT Server v5.2 and later

NextRun

EFT Server v5.2 and later

Recurrence

EFT Server v5.2 and later

TimeStart

EFT Server v5.2

WeekDayIndex

EFT Server v5.2

Weekdays

EFT Server v5.2

WeekPeriod

EFT Server v5.2

Transfer Action Parameters Interface (ICITransferActionParams)

The Transfer Action Parameters interface members are listed below. For details of how to use the properties in scripts, refer to Transfer Action Parameters Interface and Specifying Advanced Options for Transfer Action Parameters.

Members

Applicable Version

AutoLogin

EFT Server v5.2 and later

ConnectionRetryAttempts

EFT Server v6.2.10 and later

ConnectionTimeoutSeconds

EFT Server v6.2.10 and later

DeleteSourceFile

EFT Server v5.2.5 and later

FTPDataConnectionMode

EFT Server v6.2.10 and later

FTPDataConnectionPortMax

EFT Server v6.2.10 and later

FTPDataConnectionPortMin

EFT Server v6.2.10 and later

FTPSClearCommandChannel

EFT Server v6.2.10 and later

FTPSClearDataChannel

EFT Server v6.2.10 and later

Host

EFT Server v5.2 and later

Key

EFT Server v5.2.x

KeyPass

EFT Server v5.2.x

LocalPath

EFT Server v5.2 and later

MaxConcurrentThreads

EFT Server v6.2.10 and later

Operation

EFT Server v5.2.x

Password

EFT Server v5.2 and later

Port

EFT Server v5.2 and later

PreserveFileTime

EFT Server v6.2.10 and later

Protocol

EFT Server v5.2 and later

PubKey

EFT Server v5.2.x

PublicKeyPath

EFT Server 6.0 and later

RemotePath

EFT Server v5.2 and later

RetryDelaySeconds

EFT Server v6.2.10 and later

TextFileTypes

EFT Server v6.2.10 and later

User

EFT Server v5.2 and later

ValidateIntegrity

EFT Server v6.2.10 and later

Upload Action Parameters Interface (ICIUploadActionParams)

The Upload Action Parameters interface members are listed below. For details of how to use the properties in scripts, refer to Upload Action Parameters Interface Properties and Specifying Advanced Options for Transfer Action Parameters.

Members

Applicable Version

AutoLogin

EFT Server v5.25 and later

ConnectionRetryAttempts

EFT Server v6.2.10 and later

ConnectionTimeoutSeconds

EFT Server v6.2.10 and later

DeleteSourceFile

EFT Server v5.25 and later

FTPDataConnectionMode

EFT Server v6.2.10 and later

FTPDataConnectionPortMax

EFT Server v6.2.10 and later

FTPDataConnectionPortMin

EFT Server v6.2.10 and later

FTPSClearCommandChannel

EFT Server v6.2.10 and later

FTPSClearDataChannel

EFT Server v6.2.10 and later

Host

 EFT Server v5.25 and later

LocalPath

 EFT Server v5.25 and later

MaxConcurrentThreads

EFT Server v6.2.10 and later

Password

EFT Server v5.25 and later

Port

EFT Server v5.25 and later

PreserveFileTime

EFT Server v6.2.10 and later

PrivateKeyPassword

EFT Server v5.25 and later

PrivateKeyPath

EFT Server v5.25 and later

Protocol

EFT Server v5.25 and later

PublicKeyPath

EFT Server v5.25 and later

RemotePath

EFT Server v5.25 and later

RetryDelaySeconds

EFT Server v6.2.10 and later

TextFileTypes

EFT Server v6.2.10 and later

User

EFT Server v5.25 and later

ValidateIntegrity

EFT Server v6.2.10 and later

Enumerations and Constants

The enumerations and constants used in the interfaces, properties, and methods are described in List of Enumerations and Constants.