 | Ftp Class |
FTP client implementation.
Allows listing, moving, copying, downloading and uploading files using FTP/FTPS protocol.
Inheritance HierarchyNamespace: Limilabs.FTP.Client
Assembly: Ftp (in Ftp.dll) Version: 2.0.26109.1248
SyntaxThe Ftp type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Ftp | Initializes new instance of the Ftp class (IPv4 is used). |
| Ftp(AddressFamily) | Initializes new instance of the Ftp class. |
Properties| Name | Description | |
|---|---|---|
 | ActiveModeAddress | Gets or sets the IP address announced to the FTP server when establishing an Active mode data transfer. Don't set this unless needed. By default, the value of this property is None which means that the address of the network interface is used instead. This has no effect for passive mode transfers. |
| ActiveModePorts | Gets or sets the port range used in Active mode. This has no effect for passive mode transfers. |
| ASCIIChangeNewLines | Specifies if new lines should be changed when TransfersDataType is set to Ascii transfers. Default is false. |
| Configuration | Gets FTP protocol configuration. |
| Connected |
Gets a value indicating whether the underlying Socket is connected to a remote host.
This property makes a nonblocking, zero-byte Send call to determine the current state of the connection.
(Inherited from TcpTextClient) |
| DontUseCompression | Forces the compression not to be used. You should set this field before connecting to the remote server. Default value is false. |
| Extensions | Gets features container that can be used to check what FtpExtensions are supported by the server. |
| IgnorePassiveModeAddress | Ignores address sent by the FTP server for data connections in Passive mode in response to PASV command. Default is . |
| IgnorePassiveModeLocalAddress | Gets or sets the value indicating if a workaround for FTP servers that announce private range IP addresses even though a public IP was used for control connection. By default, when such address is detected, an IP address announced by the server in response to PASV command is ignored. Control's connection address is used instead. Default is . |
| IsEncrypted |
Gets a Boolean value that indicates whether communication to the remote server is encrypted.
(Inherited from TcpTextClient) |
| IsMutuallyAuthenticated |
Gets a Boolean value that indicates whether communication to the remote server is mutually authenticated.
(Inherited from TcpTextClient) |
| IsSigned |
Gets a Boolean value that indicates whether communication to the remote server is signed.
(Inherited from TcpTextClient) |
| Mode | FTP data connection mode: Active (client waits for incoming data connections) or Passive (client establishes data connections). Passive is default. |
| ProtectionBufferSize | Gets or sets the maximum size, in bytes, of the encoded data blocks to be sent or received during file transfer. |
| ReceiveTimeout |
Gets or sets the amount of time the underlying Socket will wait to receive data once a read operation is initiated.
(Inherited from TcpTextClient) |
| SendTimeout |
Gets or sets the amount of time the underlying Socket will wait for a send operation to complete successfully.
(Inherited from TcpTextClient) |
| Socket |
Gets the underlying Socket.
(Inherited from TcpTextClient) |
| SSLConfiguration |
Gets SSL configuration for this object (client certificates, enabled SSL protocols).
(Inherited from TcpTextClient) |
| Stream |
Gets underlying read stream for current connection.
(Inherited from TcpTextClient) |
| TransfersDataType | Gets or sets data type used for all data transfers. Default is Binary (I). |
| UsesCompression | Gets a value indicating whether the compression is used for data transfers. |
Methods| Name | Description | |
|---|---|---|
| Abort | Aborts current transfers. |
| Append(String, Byte) | Appends the content of the byte array to the file on the server, creating it if it doesn't exists. |
| Append(String, Stream) | Appends the content of the data streamto the file on the server, creating it if it doesn't exists. |
| AuthSSL |
Secures the communication with remote server using SSL (explicit SSL).
Please use ServerCertificateValidate event to handle self signed certificates.
Obsolete |
| AuthTLS | Secures the communication with remote server using TLS (explicit SSL/TLS) (RFC 4217). Please use ServerCertificateValidate event to handle self signed certificates. |
| BeginConnect(String) | Begins an asynchronous request for a remote server connection using DefaultPort. |
| BeginConnect(IPEndPoint, Boolean) |
Begins an asynchronous request for a remote server connection.
(Inherited from TcpTextClient) |
| BeginConnect(String, AsyncCallback) | Begins an asynchronous request for a remote server connection using DefaultPort. |
| BeginConnect(String, Int32) |
Begins an asynchronous request for a remote server connection. You can use BeginConnectSSL(String, Int32) when SSL connection is needed.
(Inherited from TcpTextClient) |
| BeginConnect(String, Int32, Boolean) |
Begins an asynchronous request for a remote server connection.
(Inherited from TcpTextClient) |
| BeginConnect(String, Int32, Boolean, AsyncCallback) |
Begins an asynchronous request for a remote server connection.
(Inherited from TcpTextClient) |
| BeginConnectSSL(String) | Begins an asynchronous request for a remote server secure connection using DefaultSSLPort and SSL. |
| BeginConnectSSL(String, AsyncCallback) | Begins an asynchronous request for a remote server secure connection using DefaultSSLPort and SSL. |
| BeginConnectSSL(String, Int32) |
Begins an asynchronous request for a remote server secure connection using SSL.
(Inherited from TcpTextClient) |
| BeginConnectSSL(String, Int32, AsyncCallback) |
Begins an asynchronous request for a remote server secure connection using SSL.
(Inherited from TcpTextClient) |
| ChangeFolder | Changes the current working folder on the server. |
| ChangeFolderUp | Changes the current working folder on the server one level up. |
| Close | Sends QUIT command. Releases all resources acquired by this object. |
| Close(Boolean) | Sends QUIT command. Releases all resources acquired by this object. |
| Connect(String) | Connects to FTP server on port 21. Use ConnectSSL(String) when SSL connection is needed. |
| Connect(IPEndPoint, Boolean) |
Connects to server.
(Inherited from TcpTextClient) |
| Connect(String, Int32) |
Connects to server. Use ConnectSSL(String, Int32) when SSL connection is needed.
(Inherited from TcpTextClient) |
| Connect(IPAddress, Int32, Boolean) |
Connects to server.
(Inherited from TcpTextClient) |
| Connect(String, Int32, Boolean) |
Connects to server.
(Inherited from TcpTextClient) |
| ConnectSSL(String) | Connects to FTP server using SSL on port 990. Please use ServerCertificateValidate for self signed certificates. |
| ConnectSSL(String, Int32) |
Connects to server using SSL.
(Inherited from TcpTextClient) |
| CreateAllFolders | Creates all the directories and subdirectories in a specified by the remotePath. Some servers implement this feature by default, in such case you can use CreateFolder(String) method. |
| CreateFolder | Creates a folder on the server. |
| DeleteFile | Deletes the file on the server. |
| DeleteFiles(ListRemoteSearchItem) | Deletes specified files from the server. |
| DeleteFiles(RemoteSearchOptions) | Deletes files from the current server folder, that match specified pattern. |
| DeleteFiles(String, RemoteSearchOptions) | Deletes files from the server, that match specified pattern. |
| DeleteFolder | Deletes an empty remote folder with the specified pathname. |
| DeleteFolderRecursively | Deletes remote folder recursively with the specified pathname. |
| Dispose |
Releases all resources acquired by this object. Closes connection, without issuing any quit commands.
(Inherited from TcpTextClient) |
 | Dispose(Boolean) |
Releases all resources acquired by this object. Closes connection, without issuing any quit commands.
(Inherited from TcpTextClient) |
| Download(String) | Downloads the remote file. |
| Download(String, Int64) | Downloads the remote file starting from the specified position. You can check the value of SupportsRestStream of Extensions property to check if this method is supported by the remote server. |
| Download(String, Stream) | Downloads the remote file to the data stream. |
| Download(String, String) | Downloads the remote file to the local file. |
| Download(String, Int64, Stream) | Downloads the remote file to the data stream starting from the specified position. You can check the value of SupportsRestStream of Extensions property to check if this method is supported by the remote server. |
| DownloadFiles(String) | Downloads remote files from the current server folder to the local location. |
| DownloadFiles(String, RemoteSearchOptions) | Downloads remote files from the current server folder to local location. |
| DownloadFiles(String, ListRemoteSearchItem) | Downloads remote files to the local location. |
| DownloadFiles(String, String) | Downloads remote files to local location. |
| DownloadFiles(String, String, RemoteSearchOptions) | Downloads remote files to the local location. |
| EndConnect |
Ends a pending asynchronous connection request.
(Inherited from TcpTextClient) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Feat | Returns the list of additional features supported by the remote server (FEAT command). |
| FileExists | Detects whether the specified file exists on the server. |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FolderExists | Detects whether the specified folder exists on the server. |
| GetCurrentFolder | Gets the absolute path of the current working folder on the remote server. |
| GetFileHash(String, FtpHashType) | Returns the checksum of the specified remote file. You can use FileHash class to compute or validate local file checksum. |
| GetFileHash(String, FtpHashType, Int64, Int64) | Returns the checksum of the specified remote file. You can use FileHash class to compute or validate local file checksum. |
| GetFileModificationTime | Returns the modification date and time of the specified remote file. This method uses MDTM command (RFC 3659), that may be NOT supported by the server. You can check the value of SupportsMDTM of Extensions property to check if this method is supported by the remote server. |
| GetFileSize | Returns the size of the specified remote file. You can check the value of SupportsSize of Extensions property to check if this method is supported by the remote server. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetList | Returns parsed list of files and folders in the current server folder. |
| GetList(String) | Returns parsed list of files and folders in the specific server folder. |
| GetServerGreeting |
Get server's greeting.
(Overrides TcpTextClientGetServerGreeting) |
| GetSupportedHashTypes |
Returns checksum types supported by the server.
Obsolete |
| GetSystem | Returns the name of the remote OS. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Hash | Returns the checksum of the specified remote file. You can use FileHash class to compute or validate local file checksum. |
| KeepAliveDuringTransfer | Sets the interval, at which a NOOP command is sent on the control connection during a file transfer. |
| KeepAliveTcp |
Sets TCP protocol keep alive (SO_KEEPALIVE) option on.
(Inherited from TcpTextClient) |
| List | Returns parsed list of files and folders in the current server folder. This method uses LIST command. There is no standard that describes LIST command response, GetList is a better choice in most cases. |
| List(String) | Returns parsed list of files and folders in the specified server folder. This method uses LIST command (RFC 959). There is no standard that describes LIST command response, GetList(String) is a better choice in most cases. |
| Login(String) | Logs user in using specified user and empty password. |
| Login(String, String) | Logs user in. |
| Login(String, String, String) | Logs user in. |
| LoginAnonymous | Logs user in using "anonymous" as user and "anonymous@example.com" as password. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MLSD | Returns parsed list of files and folders in the current server folder. This method uses MLSD command (RFC 3659), that may be NOT supported by the server. |
| MLSD(String) | Returns parsed list of files and folders in the specified folder or file information in case of a file. This method uses MLSD command (RFC 3659), that may be NOT supported by the server. |
| MLST | Returns information about current server folder. This method uses MLST command (RFC 3659), that may be NOT supported by the server. |
| MLST(String) | Returns information about current server folder. This method uses MLST command (RFC 3659), that may be NOT supported by the server. |
| NLST | Returns a list of file and folder names in the current server folder. This method uses NLST command (RFC 3659), that may be NOT supported by the server. |
| NLST(String) | Returns a list of file and folder names in the current server folder. This method uses NLST command (RFC 3659), that may be NOT supported by the server. |
| Noop | Sends NO OPeration command to the server. |
| Rename | Renames a file or folder on the server. |
| Search | Returns all files and folders on the server. |
| Search(RemoteSearchOptions) | Searches files and folders on the server that match specified pattern. |
| Search(String, RemoteSearchOptions) | Searches files and folders on the server that match specified pattern. |
| Send |
Sends the text command to server.
Adds "\r\n" to the command.
(Inherited from TcpTextClient) |
| SendCommand(String) | Executes command on the FTP server. |
| SendCommand(String, Boolean) | Executes command on the FTP server. |
| SendCommand(String, Object) | Executes command on the FTP server. |
| SendCommand(String, Boolean, Object) | Executes command on the FTP server. |
| SendDownloadCommand | Executes command on the FTP server and expects response using data channel. |
| SetFileModificationTime | Sets the modification date and time of the specified remote file. This method uses MFTM (draft-somers-ftp-mfxx-04) or MDTM (RFC 3659) commands, that may be NOT supported by the server. |
| SetTransferMode | Forces transfer mode change. |
| Site | Sends SITE command to the server. |
| SiteChangeMode(String) | Executes SITE CHMOD command: removes all privileges for all. |
| SiteChangeMode(String, UnixPermissionSet) | Executes SITE CHMOD command - changes the permissions of the file to specified value |
| SiteListFormat | Executes SITE LISTFMT command: specifies LIST subcommand format on IBM servers. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Upload(String, Byte) | Uploads the content of the byte array to the file on the server. |
| Upload(String, Stream) | Uploads the content of the data stream to the file on the server. |
| Upload(String, String) | Uploads the content of the local file to the file on the server, overriding it if it already exists. |
| Upload(String, Int64, Byte) | Uploads the content of the byte array to the file on the server starting from the specified remote position. You can check the value of SupportsRestStream of Extensions property to check if this method is supported by the remote server. |
| Upload(String, Int64, Stream) | Uploads the content of the data stream to the file on the server from the specified remote position. You can check the value of SupportsRestStream of Extensions property to check if this method is supported by the remote server. |
| UploadFiles(String) | Uploads local files to the current remote server location. |
| UploadFiles(String, LocalSearchOptions) | Uploads local files to the current remote server location. |
| UploadFiles(String, String) | Uploads local files to remote location. |
| UploadFiles(String, String, LocalSearchOptions) | Uploads local files to remote location. |
| UploadUnique(Byte) | Uploads the content of the local file to the file with unique name on the server. |
| UploadUnique(Stream) | Uploads the content of the stream to the file with unique name on the server. |
Events| Name | Description | |
|---|---|---|
 | BatchProgress | Reports progress of the current batch upload or download. |
| Progress | Reports progress of the current upload or download. This event may be raised from a different thread. |
| ServerCertificateValidate |
Event which is called for custom server certificate validation.
(Inherited from TcpTextClient) |
Fields| Name | Description | |
|---|---|---|
  | DefaultPort | Gets the number of default port used for FTP's control connection. |
| DefaultSSLPort | Gets the number of default port used for FTP's control connection using SSL. |
RemarksSee Also