Rebex API reference
Getting started
This site contains complete API reference of all Rebex .NET components. Use navigation on the left to browse the API.
See also:
- Available Rebex assemblies - describes their purpose, dependencies and namespaces.
- Available Rebex products - lists assemblies per product.
- Available Rebex packages - shows which products are grouped into advantageous packages.
Featured classes
Clients
- Ftp (Rebex FTP/SSL product)
Provides methods for communication with FTP servers. - Sftp (Rebex SFTP product)
Provides methods for communication with SFTP servers. - Scp (Rebex SFTP product)
Provides methods for communication using SCP. - Imap (Rebex Secure Mail product)
Provides methods for communication with IMAP servers. - Pop3 (Rebex Secure Mail product)
Provides methods for communication with POP3 servers. - Smtp (Rebex Secure Mail product)
Provides methods for communication with SMTP servers. - Ews (Rebex Secure Mail product)
Provides methods for communication with Exchange Web Service. - GraphClient (Rebex Graph product)
Provides methods for communication with Microsoft 365 (Exchange Online) using MS Graph API. - Ssh (Rebex SSH Shell product)
Provides methods for communication with SSH servers. - Telnet (Rebex SSH Shell product)
Provides methods for communication with Telnet servers. - Ntp (Rebex Time product)
Provides methods for communication with NTP servers. - Time (Rebex Time product)
Provides methods for communication with TIME servers (RFC 868). - Daytime (Rebex Time product)
Provides methods for communication with DAYTIME servers (RFC 867). - TlsClientSocket (Rebex TLS product)
Represents a client-side TLS-enabled TCP socket. - SyslogClient (Rebex Syslog product)
Represents a syslog client, which can send syslog messages to a syslog server. - WebClient (Rebex HTTPS product)
Provides simple methods to upload and download data from HTTP/HTTPS servers. - WebSocketClient (Rebex WebSocket product)
WebSocket client API.
Servers
- FileServer (Rebex File Server product)
Implements the SFTP/SSH server. - SyslogServer (Rebex Syslog product)
Represents a syslog server that can receive syslog messages. - TlsServerSocket (Rebex TLS product)
Represents a server-side TLS-enabled TCP socket.
Security
- TlsStream (Rebex TLS product)
Represents a TLS-enabled TCP stream. - FileEncryption (Rebex Security product)
Provides high level API for encrypting and decrypting files and streams. - XtsStream (Rebex Security product)
Implements XTS-AES, a standard algorithm for protection of stored data defined by IEEE P1619. - Certificate (
Rebex.Common.dll
assembly)
Represents an X509 v3 certificate. - CertificateChain (
Rebex.Common.dll
assembly)
Represents a chain of certificates. - CertificateIssuer (
Rebex.Common.dll
assembly)
A utility class that features a certificate issuer functionality. This can be used as a base of simple custom certification authority. - SshPrivateKey (
Rebex.Networking.dll
assembly)
Represents SSH private key (RSA, DSA, EcDSA, EdDSA, certificate-based). Private key data also includes the public key.
- MsgMessage (Rebex MSG product)
Represents an Outlook .MSG e-mail message. - MailMessage (Rebex Secure Mail product)
Represents an e-mail message that can be saved, loaded, processed or sent. - MimeMessage (Rebex Secure Mail product)
A MIME e-mail message.
Virtual File System
All classes are part of the Rebex.FileSystem.dll
assembly.
- FileNode
Represents a file in the file system. - DirectoryNode
Represents a directory (folder) in the file system. - NodeContent
Represents a content of a file. - LocalFileSystemProvider
A file system provider which provides access to the local (physical) file system. - MemoryFileSystemProvider
A file system provider which stores all the data in memory. All the file system provider data are deleted at the latest when the application process exits. - MountCapableFileSystemProvider
A unix-like file system provider which mounts other file systems to the specifiedDirectoryNode
. - ReadOnlyFileSystemProvider
Serves as the base class for read-only file system providers. - ReadWriteFileSystemProvider
Serves as the base class for read-write file system providers.
System.IO like API over Rebex Virtual File System:
- VFile
This class contains static methods that work with virtual file system files. This class provides methods that are functionally similar to the standard .NETFile
methods. - VFileInfo
Class represents a file in the virtual file system. This class provides properties and methods that are functionally similar to the standard .NETFileInfo
properties and methods. - VDirectory
This class contains static methods that work with virtual file system directories. This class provides methods that are functionally similar to the standard .NETDirectory
methods. - VDirectoryInfo
Class represents a directory in the virtual file system. This class provides properties and methods that are functionally similar to the standard .NETDirectoryInfo
properties and methods. - VFileStream
Represents a stream for a virtual system file. This class provides members that are functionally similar to the standard .NETFileStream
members.
Others
- HttpRequestCreator (Rebex HTTPS product)
Implements an interface for creating HTTP requests. - HttpRequest (Rebex HTTPS product)
This class represents HTTP and HTTPS requests. - TerminalControl (Rebex SSH Shell product)
Terminal emulator control for Windows Forms. - VirtualTerminal (Rebex SSH Shell product)
Represents a virtual off-screen terminal. - Scripting (Rebex SSH Shell product)
Provides enhanced scripting functionality. Makes it possible to programmatically send commands and process responses. - ZipArchive (Rebex ZIP product)
Represents a ZIP archive and provides methods to work with it. - Gzip (Rebex ZIP product)
Class for GZIP compression and decompression. - ZipReader (Rebex ZIP product)
Class for reading and extracting ZIP files sequentially, supporting non-seekable streams. - CompressionStream (Rebex ZIP product)
Provides a stream that uses specified compressed data format to compress data. - DecompressionStream (Rebex ZIP product)
Provides a stream that uses specified compressed data format to decompress data.