IImapClient Interface

C#

public interface IImapClient : IMailStore, 
	IMailService, IDisposable

	Name	Description
	AppendLimit	Get the maximum size of a message that can be appended to a folder.
	AuthenticationMechanisms	Get the authentication mechanisms supported by the message service. (Inherited from IMailService)
	Capabilities	Get the capabilities supported by the IMAP server.
	CheckCertificateRevocation	Get or set whether connecting via SSL/TLS should check certificate revocation. (Inherited from IMailService)
	ClientCertificates	Get or set the client SSL certificates. (Inherited from IMailService)
	Inbox	Get the Inbox folder. (Inherited from IMailStore)
	InternationalizationLevel	Get the internationalization level supported by the IMAP server.
	IsAuthenticated	Get whether or not the client is currently authenticated with the mail server. (Inherited from IMailService)
	IsConnected	Get whether or not the service is currently connected. (Inherited from IMailService)
	IsEncrypted	Get whether or not the connection is encrypted (typically via SSL or TLS). (Inherited from IMailService)
	IsIdle	Get whether or not the client is currently in the IDLE state.
	IsSecure	Get whether or not the connection is secure (typically via SSL or TLS). (Inherited from IMailService)
	IsSigned	Get whether or not the connection is signed (typically via SSL or TLS). (Inherited from IMailService)
	LocalEndPoint	Get or set the local IP end point to use when connecting to a remote host. (Inherited from IMailService)
	OtherNamespaces	Get the other namespaces. (Inherited from IMailStore)
	PersonalNamespaces	Get the personal namespaces. (Inherited from IMailStore)
	ProxyClient	Get or set the proxy client to use when connecting to a remote host. (Inherited from IMailService)
	Rights	Get the access rights supported by the IMAP server.
	ServerCertificateValidationCallback	Get or set a callback function to validate the server certificate. (Inherited from IMailService)
	SharedNamespaces	Get the shared namespaces. (Inherited from IMailStore)
	SslCipherAlgorithm	Get the negotiated SSL or TLS cipher algorithm. (Inherited from IMailService)
	SslCipherStrength	Get the negotiated SSL or TLS cipher algorithm strength. (Inherited from IMailService)
	SslHashAlgorithm	Get the negotiated SSL or TLS hash algorithm. (Inherited from IMailService)
	SslHashStrength	Get the negotiated SSL or TLS hash algorithm strength. (Inherited from IMailService)
	SslKeyExchangeAlgorithm	Get the negotiated SSL or TLS key exchange algorithm. (Inherited from IMailService)
	SslKeyExchangeStrength	Get the negotiated SSL or TLS key exchange algorithm strength. (Inherited from IMailService)
	SslProtocol	Get the negotiated SSL or TLS protocol version. (Inherited from IMailService)
	SslProtocols	Get or set the set of enabled SSL and/or TLS protocol versions that the client is allowed to use. (Inherited from IMailService)
	SupportsQuotas	Get whether or not the mail store supports quotas. (Inherited from IMailStore)
	SyncRoot	Get an object that can be used to synchronize access to the folder. (Inherited from IMailService)
	ThreadingAlgorithms	Get the threading algorithms supported by the mail store. (Inherited from IMailStore)
	Timeout	Get or set the timeout for network streaming operations, in milliseconds. (Inherited from IMailService)

Top

	Name	Description
	Authenticate(ICredentials, CancellationToken)	Authenticate using the supplied credentials. (Inherited from IMailService)
	Authenticate(SaslMechanism, CancellationToken)	Authenticate using the specified SASL mechanism. (Inherited from IMailService)
	Authenticate(Encoding, ICredentials, CancellationToken)	Authenticate using the supplied credentials. (Inherited from IMailService)
	Authenticate(String, String, CancellationToken)	Authenticate using the specified user name and password. (Inherited from IMailService)
	Authenticate(Encoding, String, String, CancellationToken)	Authenticate using the specified user name and password. (Inherited from IMailService)
	AuthenticateAsync(ICredentials, CancellationToken)	Asynchronously authenticate using the supplied credentials. (Inherited from IMailService)
	AuthenticateAsync(SaslMechanism, CancellationToken)	Asynchronously authenticate using the specified SASL mechanism. (Inherited from IMailService)
	AuthenticateAsync(Encoding, ICredentials, CancellationToken)	Asynchronously authenticate using the supplied credentials. (Inherited from IMailService)
	AuthenticateAsync(String, String, CancellationToken)	Asynchronously authenticate using the specified user name and password. (Inherited from IMailService)
	AuthenticateAsync(Encoding, String, String, CancellationToken)	Asynchronously authenticate using the specified user name and password. (Inherited from IMailService)
	Compress	Enable compression over the IMAP connection.
	CompressAsync	Asynchronously enable compression over the IMAP connection.
	Connect(String, Int32, SecureSocketOptions, CancellationToken)	Establish a connection to the specified mail server. (Inherited from IMailService)
	Connect(String, Int32, Boolean, CancellationToken)	Establish a connection to the specified mail server. (Inherited from IMailService)
	Connect(Socket, String, Int32, SecureSocketOptions, CancellationToken)	Establish a connection to the specified mail server using the provided socket. (Inherited from IMailService)
	Connect(Stream, String, Int32, SecureSocketOptions, CancellationToken)	Establish a connection to the specified mail server using the provided stream. (Inherited from IMailService)
	ConnectAsync(String, Int32, SecureSocketOptions, CancellationToken)	Asynchronously establish a connection to the specified mail server. (Inherited from IMailService)
	ConnectAsync(String, Int32, Boolean, CancellationToken)	Asynchronously establish a connection to the specified mail server. (Inherited from IMailService)
	ConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken)	Asynchronously establish a connection to the specified mail server using the provided socket. (Inherited from IMailService)
	ConnectAsync(Stream, String, Int32, SecureSocketOptions, CancellationToken)	Asynchronously establish a connection to the specified mail server using the provided stream. (Inherited from IMailService)
	DisableNotify	Disable any previously requested notification events from the IMAP server.
	DisableNotifyAsync	Asynchronously disable any previously requested notification events from the IMAP server.
	Disconnect	Disconnect the service. (Inherited from IMailService)
	DisconnectAsync	Asynchronously disconnect the service. (Inherited from IMailService)
	Dispose	(Inherited from IDisposable)
	EnableQuickResync	Enable the quick resynchronization feature. (Inherited from IMailStore)
	EnableQuickResyncAsync	Asynchronously enable the quick resynchronization feature. (Inherited from IMailStore)
	EnableUTF8	Enable the UTF8=ACCEPT extension.
	EnableUTF8Async	Asynchronously enable the UTF8=ACCEPT extension.
	GetFolder(FolderNamespace)	Get the folder for the specified namespace. (Inherited from IMailStore)
	GetFolder(SpecialFolder)	Get the specified special folder. (Inherited from IMailStore)
	GetFolder(String, CancellationToken)	Get the folder for the specified path. (Inherited from IMailStore)
	GetFolderAsync	Asynchronously get the folder for the specified path. (Inherited from IMailStore)
	GetFolders(FolderNamespace, Boolean, CancellationToken)	Get all of the folders within the specified namespace. (Inherited from IMailStore)
	GetFolders(FolderNamespace, StatusItems, Boolean, CancellationToken)	Get all of the folders within the specified namespace. (Inherited from IMailStore)
	GetFoldersAsync(FolderNamespace, Boolean, CancellationToken)	Asynchronously get all of the folders within the specified namespace. (Inherited from IMailStore)
	GetFoldersAsync(FolderNamespace, StatusItems, Boolean, CancellationToken)	Asynchronously get all of the folders within the specified namespace. (Inherited from IMailStore)
	GetMetadata(IEnumerableMetadataTag, CancellationToken)	Gets the specified metadata. (Inherited from IMailStore)
	GetMetadata(MetadataTag, CancellationToken)	Gets the specified metadata. (Inherited from IMailStore)
	GetMetadata(MetadataOptions, IEnumerableMetadataTag, CancellationToken)	Gets the specified metadata. (Inherited from IMailStore)
	GetMetadataAsync(IEnumerableMetadataTag, CancellationToken)	Asynchronously gets the specified metadata. (Inherited from IMailStore)
	GetMetadataAsync(MetadataTag, CancellationToken)	Asynchronously gets the specified metadata. (Inherited from IMailStore)
	GetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken)	Asynchronously gets the specified metadata. (Inherited from IMailStore)
	Identify	Identify the client implementation to the server and obtain the server implementation details.
	IdentifyAsync	Asynchronously identify the client implementation to the server and obtain the server implementation details.
	Idle	Toggle the ImapClient into the IDLE state.
	IdleAsync	Asynchronously toggle the ImapClient into the IDLE state.
	NoOp	Ping the message service to keep the connection alive. (Inherited from IMailService)
	NoOpAsync	Asynchronously ping the mail server to keep the connection alive. (Inherited from IMailService)
	Notify	Request the specified notification events from the IMAP server.
	NotifyAsync	Asynchronously request the specified notification events from the IMAP server.
	SetMetadata	Sets the specified metadata. (Inherited from IMailStore)
	SetMetadataAsync	Asynchronously sets the specified metadata. (Inherited from IMailStore)

Top

	Name	Description
	Alert	Occurs when a remote message store receives an alert message from the server. (Inherited from IMailStore)
	Authenticated	Occurs when the client has been successfully authenticated. (Inherited from IMailService)
	Connected	Occurs when the client has been successfully connected. (Inherited from IMailService)
	Disconnected	Occurs when the client has been disconnected. (Inherited from IMailService)
	FolderCreated	Occurs when a folder is created. (Inherited from IMailStore)
	MetadataChanged	Occurs when metadata changes. (Inherited from IMailStore)

Top

Implemented by ImapClient.

Reference

MailKit.Net.Imap Namespace