FTP Class

Properties   Methods   Events   Config Settings   Errors  

The FTP Class can be used to transfer files to and from FTP servers using the FTP protocol.

Class Name

IPWorksEDI_FTP

Procedural Interface

 ipworksedi_ftp_open();
 ipworksedi_ftp_close($res);
 ipworksedi_ftp_register_callback($res, $id, $function);
 ipworksedi_ftp_get_last_error($res);
 ipworksedi_ftp_get_last_error_code($res);
 ipworksedi_ftp_set($res, $id, $index, $value);
 ipworksedi_ftp_get($res, $id, $index);
 ipworksedi_ftp_do_abort($res);
 ipworksedi_ftp_do_append($res);
 ipworksedi_ftp_do_changeremotepath($res, $remotepath);
 ipworksedi_ftp_do_changetransfermode($res, $transfermode);
 ipworksedi_ftp_do_checkfileexists($res);
 ipworksedi_ftp_do_config($res, $configurationstring);
 ipworksedi_ftp_do_connect($res);
 ipworksedi_ftp_do_deletefile($res, $filename);
 ipworksedi_ftp_do_disconnect($res);
 ipworksedi_ftp_do_doevents($res);
 ipworksedi_ftp_do_download($res);
 ipworksedi_ftp_do_interrupt($res);
 ipworksedi_ftp_do_listdirectory($res);
 ipworksedi_ftp_do_listdirectorylong($res);
 ipworksedi_ftp_do_logoff($res);
 ipworksedi_ftp_do_logon($res);
 ipworksedi_ftp_do_makedirectory($res, $newdir);
 ipworksedi_ftp_do_queryfilesize($res);
 ipworksedi_ftp_do_queryfiletime($res);
 ipworksedi_ftp_do_queryremotepath($res);
 ipworksedi_ftp_do_removedirectory($res, $dirname);
 ipworksedi_ftp_do_renamefile($res, $newname);
 ipworksedi_ftp_do_reset($res);
 ipworksedi_ftp_do_sendcommand($res, $command);
 ipworksedi_ftp_do_storeunique($res);
 ipworksedi_ftp_do_upload($res);

Remarks

The FTP Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

The FTP Class implements a standard FTP client as specified in RFC 959 and RFC 1579 with the added option of SSL security (RFC 2228) in both the protocol and data channels.

The first step in using the class is specifying the RemoteHost, User and Password. The file to upload to or download from is given by the RemoteFile property. The file to download to or upload from is specified by LocalFile. The current path in the server is set by calling ChangeRemotePath. The Passive property is especially useful if the client is behind a firewall, which inhibits incoming connections to higher ports.

If LocalFile is set to something other than an empty string, then files are received in LocalFile, and otherwise data are received through the Transfer event. StartTransfer and EndTransfer are fired at the beginning and end of transmission.

The PITrail event traces the interaction between the client and the server (the FTP protocol interface connection).

Directory listings are received through the DirList event.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Account Property (IPWorksEDI_FTP Class)

The property includes the user account needed to log in.

Object Oriented Interface

public function getAccount();
public function setAccount($value);

Procedural Interface

ipworksedi_ftp_get($res, 1 );
ipworksedi_ftp_set($res, 1, $value );

Default Value

''

Remarks

This property contains the user account to use when logging in. Some servers may require an Account to Logon or to access specific privileges, such as uploading or deleting files.

Data Type

String

Connected Property (IPWorksEDI_FTP Class)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksedi_ftp_get($res, 2 );

Default Value

false

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

Data Type

Boolean

DirListCount Property (IPWorksEDI_FTP Class)

The number of records in the DirList arrays.

Object Oriented Interface

public function getDirListCount();

Procedural Interface

ipworksedi_ftp_get($res, 3 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DirListEntry
• DirListFileName
• DirListFileSize
• DirListFileTime
• DirListIsDir
• DirListIsSymlink

The array indices start at 0 and end at DirListCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

DirListEntry Property (IPWorksEDI_FTP Class)

This property contains the raw entry as received from the server.

Object Oriented Interface

public function getDirListEntry($entryindex);

Procedural Interface

ipworksedi_ftp_get($res, 4 , $entryindex);

Default Value

''

Remarks

This property contains the raw entry as received from the server. It is the complete unparsed entry in the directory listing.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

String

DirListFileName Property (IPWorksEDI_FTP Class)

This property shows the file name in the last directory listing.

Object Oriented Interface

public function getDirListFileName($entryindex);

Procedural Interface

ipworksedi_ftp_get($res, 5 , $entryindex);

Default Value

''

Remarks

This property shows the file name in the last directory listing. This also may be the directory name if a directory is being listed. You can tell whether it is a file or a directory by the Boolean DirListIsDir property.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

String

DirListFileSize Property (IPWorksEDI_FTP Class)

This property shows the file size in the last directory listing.

Object Oriented Interface

public function getDirListFileSize($entryindex);

Procedural Interface

ipworksedi_ftp_get($res, 6 , $entryindex);

Default Value

0

Remarks

This property shows the file size in the last directory listing.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

Long64

DirListFileTime Property (IPWorksEDI_FTP Class)

This property shows the file time in the last directory listing.

Object Oriented Interface

public function getDirListFileTime($entryindex);

Procedural Interface

ipworksedi_ftp_get($res, 7 , $entryindex);

Default Value

''

Remarks

This property shows the file time in the last directory listing. This contains the date/time stamp in which the file was created.

Note: In Unix systems, the date is given in two types of formats: If the date is in the past 12 months, the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

String

DirListIsDir Property (IPWorksEDI_FTP Class)

This property specifies whether entries in the last directory listing are directories.

Object Oriented Interface

public function getDirListIsDir($entryindex);

Procedural Interface

ipworksedi_ftp_get($res, 8 , $entryindex);

Default Value

false

Remarks

This property specifies whether entries in the last directory listing are directories. This Boolean value denotes whether or not the directory entry listed in DirListFileName is a file or a directory.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

Boolean

DirListIsSymlink Property (IPWorksEDI_FTP Class)

This property indicates whether the entry is a symbolic link.

Object Oriented Interface

public function getDirListIsSymlink($entryindex);

Procedural Interface

ipworksedi_ftp_get($res, 9 , $entryindex);

Default Value

false

Remarks

This property indicates whether the entry is a symbolic link. When the entry is a symbolic link, the value of DirListIsDir will always be False because this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or a folder, set RemoteFile and query the FileAttributes.FileIsDir property.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FirewallAutoDetect Property (IPWorksEDI_FTP Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworksedi_ftp_get($res, 10 );
ipworksedi_ftp_set($res, 10, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksEDI_FTP Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworksedi_ftp_get($res, 11 );
ipworksedi_ftp_set($res, 11, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorksEDI_FTP Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworksedi_ftp_get($res, 12 );
ipworksedi_ftp_set($res, 12, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (IPWorksEDI_FTP Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworksedi_ftp_get($res, 13 );
ipworksedi_ftp_set($res, 13, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (IPWorksEDI_FTP Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworksedi_ftp_get($res, 14 );
ipworksedi_ftp_set($res, 14, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (IPWorksEDI_FTP Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworksedi_ftp_get($res, 15 );
ipworksedi_ftp_set($res, 15, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (IPWorksEDI_FTP Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworksedi_ftp_get($res, 16 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LastReply Property (IPWorksEDI_FTP Class)

This property indicates the last reply received from the server.

Object Oriented Interface

public function getLastReply();

Procedural Interface

ipworksedi_ftp_get($res, 17 );

Default Value

''

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the PITrail event.

This property is read-only.

Data Type

String

LocalFile Property (IPWorksEDI_FTP Class)

This is the path to a local file for download or upload. If the file exists, it is overwritten.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

ipworksedi_ftp_get($res, 18 );
ipworksedi_ftp_set($res, 18, $value );

Default Value

''

Remarks

This property is used by the Upload and Download methods to specify the path to a local file to be downloaded or uploaded. See the method descriptions for more information.

Example (Setting LocalFile)

FTPControl.LocalFile = "C:\localfile.txt" FTPControl.RemoteFile = "remotefile.txt" FTPControl.Download() FTPControl.LocalFile = "C:\localfile2.txt" FTPControl.RemoteFile = "folder/remotefile2.txt" FTPControl.Download()

Data Type

String

LocalHost Property (IPWorksEDI_FTP Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworksedi_ftp_get($res, 19 );
ipworksedi_ftp_set($res, 19, $value );

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

Overwrite Property (IPWorksEDI_FTP Class)

This indicates whether or not the class should overwrite files during transfer.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

ipworksedi_ftp_get($res, 20 );
ipworksedi_ftp_set($res, 20, $value );

Default Value

false

Remarks

This property is a value indicating whether or not the class should overwrite downloaded files. If Overwrite is False, an error will be thrown whenever LocalFile exists before a download operation.

Data Type

Boolean

Passive Property (IPWorksEDI_FTP Class)

This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall.

Object Oriented Interface

public function getPassive();
public function setPassive($value);

Procedural Interface

ipworksedi_ftp_get($res, 21 );
ipworksedi_ftp_set($res, 21, $value );

Default Value

true

Remarks

This property controls whether or not to direct the server into a passive mode. Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client class expects them to be. If Passive is set to TRUE, the class will use the PASV command instead of the PORT command and thus will direct the server into a passive mode: connections are initiated only by the client.

Data Type

Boolean

Password Property (IPWorksEDI_FTP Class)

This is the password used to log in.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

ipworksedi_ftp_get($res, 22 );
ipworksedi_ftp_set($res, 22, $value );

Default Value

''

Remarks

This property contains the password used to log in. It must be set before the class connects to the FTP server.

Data Type

String

RemoteFile Property (IPWorksEDI_FTP Class)

This is the name of the remote file for uploading, downloading, and performing other operations.

Object Oriented Interface

public function getRemoteFile();
public function setRemoteFile($value);

Procedural Interface

ipworksedi_ftp_get($res, 23 );
ipworksedi_ftp_set($res, 23, $value );

Default Value

''

Remarks

This property contains the name of the remote file to be uploaded or downloaded and is either an absolute file path or a relative path based on the remote path set by calling ChangeRemotePath.

A number of methods use RemoteFile as an argument.

Example 1. Setting RemoteFile:

FTPControl.LocalFile = "C:\localfile.txt" FTPControl.RemoteFile = "remotefile.txt" FTPControl.Download() FTPControl.LocalFile = "C:\localfile2.txt" FTPControl.RemoteFile = "folder/remotefile2.txt" FTPControl.Download()

Note: As long as file masks are supported by the server, then this property will act as a file mask when performing ListDirectory or ListDirectoryLong. If not supported, then ApplyFileMaskLocally could be set to True to filter the results locally.

Example 2. Using RemoteFile as a file mask: FTPControl.RemoteFile = "*.txt" FTPControl.ListDirectory()

The following special characters are supported for pattern matching:

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

Data Type

String

RemoteHost Property (IPWorksEDI_FTP Class)

This is the domain name or IP address of the FTP server.

Object Oriented Interface

public function getRemoteHost();
public function setRemoteHost($value);

Procedural Interface

ipworksedi_ftp_get($res, 24 );
ipworksedi_ftp_set($res, 24, $value );

Default Value

''

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the FTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

String

RemotePort Property (IPWorksEDI_FTP Class)

This is the port for the FTP service (default is 21).

Object Oriented Interface

public function getRemotePort();
public function setRemotePort($value);

Procedural Interface

ipworksedi_ftp_get($res, 25 );
ipworksedi_ftp_set($res, 25, $value );

Default Value

21

Remarks

This property contains the port for the FTP service, which defaults to 21 if not set. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For an implicit Secure Sockets Layer (SSL), use port 990 (please see the SSLStartMode property for more information).

This property is not available at design time.

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (IPWorksEDI_FTP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksedi_ftp_get($res, 26 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorksEDI_FTP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksedi_ftp_get($res, 27 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorksEDI_FTP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_ftp_get($res, 28 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorksEDI_FTP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksedi_ftp_get($res, 29 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorksEDI_FTP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksedi_ftp_get($res, 30 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorksEDI_FTP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksedi_ftp_get($res, 31 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorksEDI_FTP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksedi_ftp_get($res, 32 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorksEDI_FTP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksedi_ftp_get($res, 33 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksEDI_FTP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_ftp_get($res, 34 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorksEDI_FTP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_ftp_get($res, 35 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorksEDI_FTP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksedi_ftp_get($res, 36 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksEDI_FTP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_ftp_get($res, 37 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorksEDI_FTP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksedi_ftp_get($res, 38 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorksEDI_FTP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksedi_ftp_get($res, 39 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorksEDI_FTP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_ftp_get($res, 40 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorksEDI_FTP Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworksedi_ftp_get($res, 41 );
ipworksedi_ftp_set($res, 41, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorksEDI_FTP Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworksedi_ftp_get($res, 42 );
ipworksedi_ftp_set($res, 42, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (IPWorksEDI_FTP Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworksedi_ftp_get($res, 43 );
ipworksedi_ftp_set($res, 43, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorksEDI_FTP Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksedi_ftp_get($res, 44 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksEDI_FTP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksedi_ftp_get($res, 45 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorksEDI_FTP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksedi_ftp_get($res, 46 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorksEDI_FTP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksedi_ftp_get($res, 47 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorksEDI_FTP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksedi_ftp_get($res, 48 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorksEDI_FTP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksedi_ftp_get($res, 49 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorksEDI_FTP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksedi_ftp_get($res, 50 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorksEDI_FTP Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworksedi_ftp_get($res, 51 );
ipworksedi_ftp_set($res, 51, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorksEDI_FTP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksedi_ftp_get($res, 52 );
ipworksedi_ftp_set($res, 52, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (IPWorksEDI_FTP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksedi_ftp_get($res, 53 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorksEDI_FTP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksedi_ftp_get($res, 54 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorksEDI_FTP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksedi_ftp_get($res, 55 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorksEDI_FTP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksedi_ftp_get($res, 56 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorksEDI_FTP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksedi_ftp_get($res, 57 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorksEDI_FTP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksedi_ftp_get($res, 58 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorksEDI_FTP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksedi_ftp_get($res, 59 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorksEDI_FTP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksedi_ftp_get($res, 60 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorksEDI_FTP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_ftp_get($res, 61 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorksEDI_FTP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksedi_ftp_get($res, 62 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorksEDI_FTP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksedi_ftp_get($res, 63 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorksEDI_FTP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_ftp_get($res, 64 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorksEDI_FTP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksedi_ftp_get($res, 65 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorksEDI_FTP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksedi_ftp_get($res, 66 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorksEDI_FTP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksedi_ftp_get($res, 67 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorksEDI_FTP Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworksedi_ftp_get($res, 68 );
ipworksedi_ftp_set($res, 68, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorksEDI_FTP Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworksedi_ftp_get($res, 69 );
ipworksedi_ftp_set($res, 69, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (IPWorksEDI_FTP Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworksedi_ftp_get($res, 70 );
ipworksedi_ftp_set($res, 70, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorksEDI_FTP Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksedi_ftp_get($res, 71 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksEDI_FTP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksedi_ftp_get($res, 72 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorksEDI_FTP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksedi_ftp_get($res, 73 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorksEDI_FTP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksedi_ftp_get($res, 74 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorksEDI_FTP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksedi_ftp_get($res, 75 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorksEDI_FTP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksedi_ftp_get($res, 76 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorksEDI_FTP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksedi_ftp_get($res, 77 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorksEDI_FTP Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworksedi_ftp_get($res, 78 );
ipworksedi_ftp_set($res, 78, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (IPWorksEDI_FTP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworksedi_ftp_get($res, 79 );
ipworksedi_ftp_set($res, 79, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLEnabled Property (IPWorksEDI_FTP Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Object Oriented Interface

public function getSSLEnabled();
public function setSSLEnabled($value);

Procedural Interface

ipworksedi_ftp_get($res, 80 );
ipworksedi_ftp_set($res, 80, $value );

Default Value

false

Remarks

This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (IPWorksEDI_FTP Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworksedi_ftp_get($res, 81 );
ipworksedi_ftp_set($res, 81, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (IPWorksEDI_FTP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksedi_ftp_get($res, 82 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorksEDI_FTP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksedi_ftp_get($res, 83 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorksEDI_FTP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_ftp_get($res, 84 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorksEDI_FTP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksedi_ftp_get($res, 85 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorksEDI_FTP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksedi_ftp_get($res, 86 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorksEDI_FTP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksedi_ftp_get($res, 87 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorksEDI_FTP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksedi_ftp_get($res, 88 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorksEDI_FTP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksedi_ftp_get($res, 89 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorksEDI_FTP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_ftp_get($res, 90 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorksEDI_FTP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_ftp_get($res, 91 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorksEDI_FTP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksedi_ftp_get($res, 92 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorksEDI_FTP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_ftp_get($res, 93 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorksEDI_FTP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksedi_ftp_get($res, 94 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorksEDI_FTP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksedi_ftp_get($res, 95 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorksEDI_FTP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_ftp_get($res, 96 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorksEDI_FTP Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksedi_ftp_get($res, 97 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorksEDI_FTP Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworksedi_ftp_get($res, 98 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorksEDI_FTP Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksedi_ftp_get($res, 99 );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorksEDI_FTP Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksedi_ftp_get($res, 100 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksEDI_FTP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksedi_ftp_get($res, 101 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorksEDI_FTP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksedi_ftp_get($res, 102 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorksEDI_FTP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksedi_ftp_get($res, 103 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorksEDI_FTP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksedi_ftp_get($res, 104 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorksEDI_FTP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksedi_ftp_get($res, 105 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorksEDI_FTP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksedi_ftp_get($res, 106 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorksEDI_FTP Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksedi_ftp_get($res, 107 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorksEDI_FTP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksedi_ftp_get($res, 108 );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

SSLStartMode Property (IPWorksEDI_FTP Class)

This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.

Object Oriented Interface

public function getSSLStartMode();
public function setSSLStartMode($value);

Procedural Interface

ipworksedi_ftp_get($res, 109 );
ipworksedi_ftp_set($res, 109, $value );

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

StartByte Property (IPWorksEDI_FTP Class)

This is the byte index in RemoteFile and LocalFile from which to start a transmission.

Object Oriented Interface

public function getStartByte();
public function setStartByte($value);

Procedural Interface

ipworksedi_ftp_get($res, 110 );
ipworksedi_ftp_set($res, 110, $value );

Default Value

'0'

Remarks

This property contains a zero-based index in both RemoteFile and LocalFile that determines the point from which the transmission of data begins. This is useful for resuming interrupted downloads and uploads of files from FTP servers.

Once set, the StartByte index is used for all future downloads and uploads. The property must be reset to "0" for normal downloads and uploads.

The type of the property is a string instead of numeric value to allow for certain implementations that expect an alphanumeric marker for the start index.

In the Transfer event, the TransferredBytes parameter will include the bytes skipped (i.e., it will show StartByte more bytes than actually transferred).

Note: Some FTP servers may not support the FTP REST command. If that is the case with the server you are accessing, you will not be able to use the StartByte property.

This property is not available at design time.

Data Type

String

Timeout Property (IPWorksEDI_FTP Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksedi_ftp_get($res, 111 );
ipworksedi_ftp_set($res, 111, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferMode Property (IPWorksEDI_FTP Class)

This property indicates the transfer mode (ASCII or binary). If the value is 0 (default), the initial server mode will be used.

Object Oriented Interface

public function getTransferMode();

Procedural Interface

ipworksedi_ftp_get($res, 112 );

Default Value

0

Remarks

This property indicates the current transfer mode, which is either ASCII or binary. To change the transfer mode call the ChangeTransferMode method. Possible values for this property are:

This property is read-only.

Data Type

Integer

User Property (IPWorksEDI_FTP Class)

This property contains the user identifier to use to log in.

Object Oriented Interface

public function getUser();
public function setUser($value);

Procedural Interface

ipworksedi_ftp_get($res, 113 );
ipworksedi_ftp_set($res, 113, $value );

Default Value

''

Remarks

This property contains the user identifier to be used when logging in. It must be set before the class connects to the FTP server.

Data Type

String

Abort Method (IPWorksEDI_FTP Class)

The method aborts the current upload or download.

Object Oriented Interface

public function doAbort();

Procedural Interface

ipworksedi_ftp_do_abort($res);

Remarks

This method sends an ABOR command to the FTP server. It is used to interrupt file uploads and downloads.

Append Method (IPWorksEDI_FTP Class)

This method appends data from LocalFile to a RemoteFile on an FTP server.

Object Oriented Interface

public function doAppend();

Procedural Interface

ipworksedi_ftp_do_append($res);

Remarks

This method causes the server-data transfer process (DTP) to accept the data transferred through the data connection and to store the data in a file on the server site. If the file specified in the pathname exists on the server site, then the data shall be appended to that file; otherwise, the file specified in the pathname shall be created on the server site. This method is similar to the Upload method, but the local file specified by LocalFile is appended to RemoteFile on the server as opposed to replacing it, as with the Upload method. RemoteFile is either an absolute path on the server, or a path relative to the current path set by ChangeRemotePath. The server will create a file with that name if it doesn't already exist (similar to upload). If no FTP session is in place, one is automatically created by first calling the Logon method.

ChangeRemotePath Method (IPWorksEDI_FTP Class)

This method changes the current path on the FTP server.

Object Oriented Interface

public function doChangeRemotePath($remotepath);

Procedural Interface

ipworksedi_ftp_do_changeremotepath($res, $remotepath);

Remarks

This method changes the current path on the FTP server to the specified RemotePath. When called, the class will issue a command to the server to change the directory. The RemotePath parameter may hold an absolute or relative path.

Absolute Paths

If the path begins with a /, it is considered an absolute path and must specify the entire path from the root of the server. For instance:

component.ChangeRemotePath("/home/testuser/myfolder");

Relative Paths

If the path does not begin with a /, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of myfolder will indicate a subfolder of the current directory. The special value .. refers to the parent directory of the current path. For instance:

//Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder");

ChangeTransferMode Method (IPWorksEDI_FTP Class)

This method changes the transfer mode for the current connection.

Object Oriented Interface

public function doChangeTransferMode($transfermode);

Procedural Interface

ipworksedi_ftp_do_changetransfermode($res, $transfermode);

Remarks

This method optionally changes the transfer mode used for the connection. The TransferMode parameter indicates the new transfer mode to be used.

In many cases, it is not necessary to explicitly change the transfer mode; however, the binary transfer mode is useful to ensure that files are preserved byte-for-byte during the transfer. For instance, when uploading or downloading images or archives, the binary transfer mode will ensure that no line-ending transformations are performed by the server before data are transmitted.

Valid values for the TransferMode parameter are as follows:

CheckFileExists Method (IPWorksEDI_FTP Class)

This method returns True if the file specified by RemoteFile exists on the server.

Object Oriented Interface

public function doCheckFileExists();

Procedural Interface

ipworksedi_ftp_do_checkfileexists($res);

Remarks

This method sends a command to the server to determine if the file specified by RemoteFile exists. If the file exists, this method returns true, otherwise it returns false. RemoteFile must be specified before calling this method. For instance: component.ChangeRemotePath("/home/testuser/myfolder"); component.RemoteFile = "test.txt"; if(component.CheckFileExists()) { //Do something }

Config Method (IPWorksEDI_FTP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksedi_ftp_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (IPWorksEDI_FTP Class)

This method connects to the FTP server without logging in.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksedi_ftp_do_connect($res);

Remarks

This method establishes a connection with the RemoteHost but does not log in. In most cases, it is recommended to use the Logon method, which will both establish a connection and log in to the server.

This method may be useful in cases in which it is desirable to separate the connection and logon operations, for instance, confirming that a host is available by first creating the connection.

DeleteFile Method (IPWorksEDI_FTP Class)

This method removes a file specified by FileName from an FTP server.

Object Oriented Interface

public function doDeleteFile($filename);

Procedural Interface

ipworksedi_ftp_do_deletefile($res, $filename);

Remarks

This method is used to remove a file specified by FileName from an FTP server. The remote file or directory specified by FileName is deleted. FileName is either an absolute path on the server, or a path relative to remote path set by ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

Disconnect Method (IPWorksEDI_FTP Class)

This method disconnects from the server without first logging off.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksedi_ftp_do_disconnect($res);

Remarks

This method immediately disconnects from the server without first logging off.

In most cases, the Logoff method should be used to log off and disconnect from the server. Call the Disconnect method in cases in which it is desirable to immediately disconnect without first logging off.

DoEvents Method (IPWorksEDI_FTP Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksedi_ftp_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Download Method (IPWorksEDI_FTP Class)

This method downloads a RemoteFile from an FTP server.

Object Oriented Interface

public function doDownload();

Procedural Interface

ipworksedi_ftp_do_download($res);

Remarks

This method is used to download the remote file specified by RemoteFile to the local file specified by LocalFile, or it is retrieved through the Transfer event if the LocalFile property is "" (empty string). RemoteFile is either an absolute path on the server or a path relative to a remote path set by calling ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

Example (Download a File)

FTPControl.LocalFile = "C:\localfile.txt" FTPControl.RemoteFile = "remotefile.txt" FTPControl.Download() FTPControl.LocalFile = "C:\localfile2.txt" FTPControl.RemoteFile = "folder/remotefile2.txt" FTPControl.Download()

Interrupt Method (IPWorksEDI_FTP Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksedi_ftp_do_interrupt($res);

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListDirectory Method (IPWorksEDI_FTP Class)

List the current directory specified by ChangeRemotePath on an FTP server.

Object Oriented Interface

public function doListDirectory();

Procedural Interface

ipworksedi_ftp_do_listdirectory($res);

Remarks

This method is used to list the directory (or file mask) specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to the remote path set by ChangeRemotePath. The file listing is received through the DirList event.

Similar to ListDirectoryLong, except that only file names are returned.

Note: Because RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to an empty string or a mask like "*". If no FTP session is in place, one is automatically created by first calling the Logon method.

ListDirectoryLong Method (IPWorksEDI_FTP Class)

This method lists extended directory information for the remote path specified by calling ChangeRemotePath .

Object Oriented Interface

public function doListDirectoryLong();

Procedural Interface

ipworksedi_ftp_do_listdirectorylong($res);

Remarks

This method is used to request a directory (or file mask) listing specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to the remote path set by calling ChangeRemotePath. The file listing is received through the DirList event. Extended file information is returned.

Note: Because RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to empty string or a mask like "*". If no FTP session is in place, one is automatically created by first calling the Logon method.

Logoff Method (IPWorksEDI_FTP Class)

This method is used to log off from the FTP server by posting a QUIT command.

Object Oriented Interface

public function doLogoff();

Procedural Interface

ipworksedi_ftp_do_logoff($res);

Remarks

This method is used to log off from the FTP server by posting a QUIT command. If that fails, the connection is terminated by the local host.

Logon Method (IPWorksEDI_FTP Class)

This method is used to log on to the FTP RemoteHost using the current User and Password .

Object Oriented Interface

public function doLogon();

Procedural Interface

ipworksedi_ftp_do_logon($res);

Remarks

This method is used to log on to the FTP server using the current User and Password. If TransferMode is not 0 (Default), then the FTP transfer mode is set to the appropriate value.

Example (Logging On)

FTPControl.RemoteHost = "ftpserver" FTPControl.User = "username" FTPControl.Password = "password" FTPControl.Logon()

MakeDirectory Method (IPWorksEDI_FTP Class)

This method is used to create a directory on the FTP server.

Object Oriented Interface

public function doMakeDirectory($newdir);

Procedural Interface

ipworksedi_ftp_do_makedirectory($res, $newdir);

Remarks

This method is used to create a directory with a path specified by NewDir on the FTP server. NewDir is either an absolute path on the server, or a path relative to the remote path that is set by calling ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

Note: When MakeDirectory is called, RemoteFile is changed to NewDir.

QueryFileSize Method (IPWorksEDI_FTP Class)

This returns the size of the file specified by RemoteFile .

Object Oriented Interface

public function doQueryFileSize();

Procedural Interface

ipworksedi_ftp_do_queryfilesize($res);

Remarks

This method sends the SIZE command to the server to obtain the size (in bytes) of the file specified by RemoteFile. RemoteFile must be specified before calling this method. For instance: component.ChangeRemotePath("/home/testuser/myfolder"); component.RemoteFile = "test.txt"; long myFileSize = component.QueryFileSize();

If RemoteFile does not exist on the server, the class fails with an error.

QueryFileTime Method (IPWorksEDI_FTP Class)

This returns the modified time of the file specified by RemoteFile .

Object Oriented Interface

public function doQueryFileTime();

Procedural Interface

ipworksedi_ftp_do_queryfiletime($res);

Remarks

This method sends the MDTM command to the server to obtain the modified time of the file specified by RemoteFile. The time returned by this method will be converted to the local timezone. RemoteFile must be specified before calling this method. For instance: component.ChangeRemotePath("/home/testuser/myfolder"); component.RemoteFile = "test.txt"; string myModifiedTime = component.QueryFileTime();

The FileTimeFormat configuration setting controls the format of the returned value.

QueryRemotePath Method (IPWorksEDI_FTP Class)

This queries the server for the current path.

Object Oriented Interface

public function doQueryRemotePath();

Procedural Interface

ipworksedi_ftp_do_queryremotepath($res);

Remarks

This method queries the server for the current path. When called, the class will issue a command to the server to retrieve the current path value. The return value of this method is the path returned by the server. For instance:

string remotePath = component.QueryRemotePath();

RemoveDirectory Method (IPWorksEDI_FTP Class)

This removes a directory specified by DirName from an FTP server.

Object Oriented Interface

public function doRemoveDirectory($dirname);

Procedural Interface

ipworksedi_ftp_do_removedirectory($res, $dirname);

Remarks

This method is used to remove a directory with path specified by DirName from the FTP server. DirName is either an absolute path on the server, or a path relative to the remote path set by calling ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

RenameFile Method (IPWorksEDI_FTP Class)

This changes the name of RemoteFile to NewName .

Object Oriented Interface

public function doRenameFile($newname);

Procedural Interface

ipworksedi_ftp_do_renamefile($res, $newname);

Remarks

This method is used to change the name of a remote file, specified by RemoteFile to NewName. RemoteFile and NewName are either absolute paths on the server, or a path relative to a remote path set by calling ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

Reset Method (IPWorksEDI_FTP Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_ftp_do_reset($res);

Remarks

This method will reset the class's properties to their default values.

SendCommand Method (IPWorksEDI_FTP Class)

This method sends the exact command directly to the server.

Object Oriented Interface

public function doSendCommand($command);

Procedural Interface

ipworksedi_ftp_do_sendcommand($res, $command);

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method, check the LastReply property or monitor the PITrail event to obtain the server's response.

StoreUnique Method (IPWorksEDI_FTP Class)

This method uploads a file with a unique name to an FTP server.

Object Oriented Interface

public function doStoreUnique();

Procedural Interface

ipworksedi_ftp_do_storeunique($res);

Remarks

This method is used to upload a file with a unique name to an FTP server. This is similar to the Upload method, but the server determines a unique name for the LocalFile to be saved on the current directory set by calling ChangeRemotePath. The server includes the new name of the file in its response. The user should check the PITrail event, or LastReply property to retrieve this generated filename.

Upload Method (IPWorksEDI_FTP Class)

This method uploads a file specified by LocalFile to an FTP server.

Object Oriented Interface

public function doUpload();

Procedural Interface

ipworksedi_ftp_do_upload($res);

Remarks

This method uploads a local file specified by LocalFile to the remote file specified by RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to the remote path set by calling ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

If you want to append to a server file, please refer to the Append method.

Example 1: Upload a File

FTPControl.LocalFile = "C:\localfile.txt" FTPControl.RemoteFile = "remotefile.txt" FTPControl.Upload() FTPControl.LocalFile = "C:\localfile2.txt" FTPControl.RemoteFile = "folder/remotefile2.txt" FTPControl.Upload()

ConnectionStatus Event (IPWorksEDI_FTP Class)

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksedi_ftp_register_callback($res, 1, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

DirList Event (IPWorksEDI_FTP Class)

This event is fired when a directory entry is received.

Object Oriented Interface

public function fireDirList($param);

Procedural Interface

ipworksedi_ftp_register_callback($res, 2, array($this, 'fireDirList'));

Parameter List

 'direntry'
 'filename'
 'isdir'
 'filesize'
 'filetime'

Remarks

The DirList events are fired when a directory listing is received as a response to a ListDirectory or ListDirectoryLong call.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The DirEntry parameter contains the filename when ListDirectory is called and includes extended file information when ListDirectoryLong is called.

The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectoryLong method. Except for FileName, these parameters are empty when a short "List Directory" is performed.

In Unix systems, the date is given in two types of formats: If the date is in the past 12 months the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

EndTransfer Event (IPWorksEDI_FTP Class)

This event is fired when a file finishes downloading or uploading.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksedi_ftp_register_callback($res, 3, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

The EndTransfer event fires when a Data Interface connection is closed. This occurs when the file finishes transferring or a directory listing is finished.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (IPWorksEDI_FTP Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksedi_ftp_register_callback($res, 4, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

PITrail Event (IPWorksEDI_FTP Class)

This event traces the commands sent to the server, and the respective replies.

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworksedi_ftp_register_callback($res, 5, array($this, 'firePITrail'));

Parameter List

 'direction'
 'message'

Remarks

The PITrail event is useful for debugging purposes. It shows all of the interactions between the client and the server, line by line.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

SSLServerAuthentication Event (IPWorksEDI_FTP Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksedi_ftp_register_callback($res, 6, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (IPWorksEDI_FTP Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksedi_ftp_register_callback($res, 7, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (IPWorksEDI_FTP Class)

This event fires when a file starts downloading or uploading.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksedi_ftp_register_callback($res, 8, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The StartTransfer event fires when a Data Interface connection is created. This is when the file starts transferring or a directory listing is started.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (IPWorksEDI_FTP Class)

This event is fired during the file download or upload.

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksedi_ftp_register_callback($res, 9, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (FTP Class)

FTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (FTP Class)

FTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

TCP/IP Errors