FTPClient ConfigurationThe class accepts one or more of the following configuration settings. Configuration 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.
FTPClient Configuration Settings
|AccountInfo: Parameters for the ACCT command.Specifies the parameter for ACCT command. If AccountInfo is set, the client automatically sends ACCT command to the server during authentication.|
|AuthCmd: Authorization command to be used to request an explicit SSL session.Use this property to specify the authorization command that will be used to request an explicit SSL session. The following choices are possible: 0 - Auto, 1 - TLS, 2 - SSL, 3 - TLSP, 4 - TLSC. Different servers support different commands, so in most cases it is a good idea to set this property to 0.|
|CaseConversion: Whether file names and paths should be case-converted.Defines whether file names are converted (on the destination system) to: lowercase (1), uppercase (2).|
|CaseSensitive: Case-sensitivity of file names and paths.Whether file paths and names are case-sensitive.|
|CloseQuietly: Set this to true to avoid sending QUIT command on session closure.Set this property to true to tell the component not to send the QUIT command when closing the connection.|
|ConcurrentConnections: Number of simultaneous connections for download.The maximum number of concurrent connections that may be opened for download. This feature is not available if the server does not support file size requests.|
|CopyMode: What to do with the originals of the copied files.Defines what to do with the originals of the files which have been copied. You can choose to just leave them, delete each original right after it has been copied, or delete files only when all of them have been transferred.|
|ErrorOrigin: Specifies where the error has been originated.Specifies where the error has been originated, on the server or client side.|
|ErrorSeverity: Error severity.Specifies whether a warning or an error encountered.|
|EventOrigin: Indicates the channel that has fired the event.Check this read-only property in event handlers to identify whether the event originates from the FTP protocol's control or data channel. While some events are channel-independent (FileOperation, ListEntry), and some other are explicitly bound to the control channel (ControlSend, ControlReceive), some events may be thrown from either. Two examples of such events are CertificateValidate and RemoteSign. The property can be set to one of the following values: feoUnknown (0), feoControl (1), feoData (2).|
|ExtHOSTSupported: Whether HOST extension is supported.Use this read-only property to check whether the FTP server supports HOST command.|
|ExtMDTMSupported: Whether MDTM extension is supported.Use this read-only property to check whether the FTP server supports MDTM command. The MDTM command is used to determine file modification date.|
|ExtMFMTSupported: Whether MFMT extension is supported.Use this read-only property to check whether the FTP server supports MFMT (Modify Fact: Modification Time) command.|
|ExtMLSTSupported: Whether MLST extension is supported.Use this read-only property to check whether the FTP server supports MLST command. This command lists the directory contents on the server, although it is different from the LIST command. In particular, MLST reply has a strictly defined format.|
|ExtOPTSUTF8Supported: Whether OPTS UTF8 extension is supported.Use this read-only property to check whether the FTP server supports OPTS UTF8 ON command. This command switches the server to UTF8.|
|ExtRESTSupported: Whether REST extension is supported.Use this read-only property to check whether the FTP server supports REST (RESTART) command.|
|ExtSIZESupported: Whether SIZE extension is supported.Use this read-only property to check whether the FTP server supports SIZE command. This command returns file size.|
|ExtXCRCSupported: Whether XCRC extension is supported.Use this read-only property to check whether the FTP server supports XCRC command. It calculates a CRC checksum of the file to check its integrity during transfer.|
|ExtXMD5Supported: Whether XMD5 extension is supported.Use this read-only property to check whether the FTP server supports XMD5 command. It calculates an MD5 checksum of a file to check its integrity during transfer.|
|FTPBufferSize: Buffer size in binary mode.The size of the memory buffer used for data transfer in binary mode. Changing the buffer size may increase (or, on the contrary, decrease) the speed of file download/upload.|
|FTPTextBufferSize: Buffer size in text mode.The size of the memory buffer used for data transfer in text mode. Changing the buffer size may increase (or, on the contrary, decrease) the speed of file download/upload.|
Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component should trust the
certificates residing in the Trusted Root Certification Authorities store.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted.
|ListenTimeout: Listening socket timeout.The maximum time during which the listening socket will be opened in the active mode. If there is no connection request from the server during this time, the transfer operation will be canceled.|
|LocalNewLineConvention: Defines the local newline convention.Contains character string for the end of string indication used on the local machine. During file upload all the LocalNewLineConvention line endings are converted to newline endings used on the server. Correspondingly, for all downloaded files line endings are replaced with LocalNewLineConventionline endings. Line ending conventions are only used in text transfer mode.|
|MinSizeForConcurrentDownload: Files bigger than this size will be downloaded concurrently.The minimum size of the file for which the concurrent download is used. The value of ConcurrentConnections property is ignored for smaller files.|
|Mode: What to do if the destination file already exists.Specifies what to do if the destination file already exists. You can choose to: overwrite, append, resume, overwrite only if the destination file's size is different, save with a new name, or rename the existing destination file.|
|ModeZ: Switches on data compression.Switches the in-flight data compression on/off.|
|Options: Various FTP options.Various options of FTP connection.|
|Recursive: Whether to scan subdirectories.Whether the subdirectories should also be scanned for matching files.|
|TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored.|
|TolerateMinorChainIssues: Whether to tolerate minor chain issues.TBD|
|TransferKeepAliveInterval: Keep-alive interval for the data channel transfers.FTPClient may be configured to send occasional NOOP commands on the control channel to circumvent control channel closures by firewalls due to inactivity. This setting sets the period, in milliseconds, after which another NOOP request is sent. The default value of this property is 0, which stands for no NOOP requests.|
|TransferTimeout: Timeout for data transfer in active mode.In active mode, specifies a time period that a client should wait for incoming data connection (when file or directory listing is to be transferred). If no data connection is accepted during this period, the data connection will be cancelled.|
|UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.|
|UseProxySettingsForDataChannel: Whether the proxy settings should be applied to data channel.Whether the proxy settings should be applied to data channel.|
|UseSystemCertificates: Enables or disables the use of the system certificates.Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.|
Base Configuration Settings
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys.
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.|
|DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.|
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3.
|GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".|
|HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.|
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|LogFile: Specifies the debug log filename.Use this property to provide a path to the log file.|
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100.
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.|
|MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.|
|OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.|
|UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.|
|UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.|
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store.
|UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.|