Click or drag to resize
MimeKit

IImapClient Interface

An interface for an IMAP client.

Namespace:  MailKit.Net.Imap
Assembly:  MailKit (in MailKit.dll) Version: 2.14.0
Syntax
C#
public interface IImapClient : IMailStore, 
	IMailService, IDisposable

The IImapClient type exposes the following members.

Properties
  NameDescription
Public propertyAppendLimit
Gets the maximum size of a message that can be appended to a folder.
Public propertyAuthenticationMechanisms
Get the authentication mechanisms supported by the message service.
(Inherited from IMailService.)
Public propertyCode exampleCapabilities
Get the capabilities supported by the IMAP server.
Public propertyCheckCertificateRevocation
Get or set whether connecting via SSL/TLS should check certificate revocation.
(Inherited from IMailService.)
Public propertyClientCertificates
Get or set the client SSL certificates.
(Inherited from IMailService.)
Public propertyInbox
Get the Inbox folder.
(Inherited from IMailStore.)
Public propertyInternationalizationLevel
Gets the internationalization level supported by the IMAP server.
Public propertyIsAuthenticated
Get whether or not the client is currently authenticated with the mail server.
(Inherited from IMailService.)
Public propertyIsConnected
Get whether or not the service is currently connected.
(Inherited from IMailService.)
Public propertyIsEncrypted
Get whether or not the connection is encrypted (typically via SSL or TLS).
(Inherited from IMailService.)
Public propertyIsIdle
Get whether or not the client is currently in the IDLE state.
Public propertyIsSecure
Get whether or not the connection is secure (typically via SSL or TLS).
(Inherited from IMailService.)
Public propertyIsSigned
Get whether or not the connection is signed (typically via SSL or TLS).
(Inherited from IMailService.)
Public propertyLocalEndPoint
Get or set the local IP end point to use when connecting to a remote host.
(Inherited from IMailService.)
Public propertyOtherNamespaces
Get the other namespaces.
(Inherited from IMailStore.)
Public propertyPersonalNamespaces
Get the personal namespaces.
(Inherited from IMailStore.)
Public propertyProxyClient
Get or set the proxy client to use when connecting to a remote host.
(Inherited from IMailService.)
Public propertyCode exampleRights
Get the access rights supported by the IMAP server.
Public propertyCode exampleServerCertificateValidationCallback
Get or sets a callback function to validate the server certificate.
(Inherited from IMailService.)
Public propertySharedNamespaces
Get the shared namespaces.
(Inherited from IMailStore.)
Public propertySslCipherAlgorithm
Get the negotiated SSL or TLS cipher algorithm.
(Inherited from IMailService.)
Public propertySslCipherStrength
Get the negotiated SSL or TLS cipher algorithm strength.
(Inherited from IMailService.)
Public propertySslHashAlgorithm
Get the negotiated SSL or TLS hash algorithm.
(Inherited from IMailService.)
Public propertySslHashStrength
Get the negotiated SSL or TLS hash algorithm strength.
(Inherited from IMailService.)
Public propertySslKeyExchangeAlgorithm
Get the negotiated SSL or TLS key exchange algorithm.
(Inherited from IMailService.)
Public propertySslKeyExchangeStrength
Get the negotiated SSL or TLS key exchange algorithm strength.
(Inherited from IMailService.)
Public propertySslProtocol
Get the negotiated SSL or TLS protocol version.
(Inherited from IMailService.)
Public propertySslProtocols
Gets or sets the set of enabled SSL and/or TLS protocol versions that the client is allowed to use.
(Inherited from IMailService.)
Public propertySupportsQuotas
Get whether or not the mail store supports quotas.
(Inherited from IMailStore.)
Public propertySyncRoot
Gets an object that can be used to synchronize access to the folder.
(Inherited from IMailService.)
Public propertyCode exampleThreadingAlgorithms
Get the threading algorithms supported by the mail store.
(Inherited from IMailStore.)
Public propertyTimeout
Get or set the timeout for network streaming operations, in milliseconds.
(Inherited from IMailService.)
Top
Methods
  NameDescription
Public methodAuthenticate(ICredentials, CancellationToken)
Authenticate using the supplied credentials.
(Inherited from IMailService.)
Public methodAuthenticate(SaslMechanism, CancellationToken)
Authenticate using the specified SASL mechanism.
(Inherited from IMailService.)
Public methodCode exampleAuthenticate(String, String, CancellationToken)
Authenticate using the specified user name and password.
(Inherited from IMailService.)
Public methodAuthenticate(Encoding, ICredentials, CancellationToken)
Authenticate using the supplied credentials.
(Inherited from IMailService.)
Public methodAuthenticate(Encoding, String, String, CancellationToken)
Authenticate using the specified user name and password.
(Inherited from IMailService.)
Public methodAuthenticateAsync(ICredentials, CancellationToken)
Asynchronously authenticate using the supplied credentials.
(Inherited from IMailService.)
Public methodAuthenticateAsync(SaslMechanism, CancellationToken)
Asynchronously authenticate using the specified SASL mechanism.
(Inherited from IMailService.)
Public methodAuthenticateAsync(String, String, CancellationToken)
Asynchronously authenticate using the specified user name and password.
(Inherited from IMailService.)
Public methodAuthenticateAsync(Encoding, ICredentials, CancellationToken)
Asynchronously authenticate using the supplied credentials.
(Inherited from IMailService.)
Public methodAuthenticateAsync(Encoding, String, String, CancellationToken)
Asynchronously authenticate using the specified user name and password.
(Inherited from IMailService.)
Public methodCompress
Enable compression over the IMAP connection.
Public methodCompressAsync
Asynchronously enable compression over the IMAP connection.
Public methodConnect(String, Int32, SecureSocketOptions, CancellationToken)
Establish a connection to the specified mail server.
(Inherited from IMailService.)
Public methodConnect(String, Int32, Boolean, CancellationToken)
Establish a connection to the specified mail server.
(Inherited from IMailService.)
Public methodConnect(Stream, String, Int32, SecureSocketOptions, CancellationToken)
Establish a connection to the specified mail server using the provided stream.
(Inherited from IMailService.)
Public methodConnect(Socket, String, Int32, SecureSocketOptions, CancellationToken)
Establish a connection to the specified mail server using the provided socket.
(Inherited from IMailService.)
Public methodConnectAsync(String, Int32, SecureSocketOptions, CancellationToken)
Asynchronously establish a connection to the specified mail server.
(Inherited from IMailService.)
Public methodConnectAsync(String, Int32, Boolean, CancellationToken)
Asynchronously establish a connection to the specified mail server.
(Inherited from IMailService.)
Public methodConnectAsync(Stream, String, Int32, SecureSocketOptions, CancellationToken)
Asynchronously establish a connection to the specified mail server using the provided stream.
(Inherited from IMailService.)
Public methodConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken)
Asynchronously establish a connection to the specified mail server using the provided socket.
(Inherited from IMailService.)
Public methodDisableNotify
Disable any previously requested notification events from the IMAP server.
Public methodDisableNotifyAsync
Asynchronously disable any previously requested notification events from the IMAP server.
Public methodDisconnect
Disconnect the service.
(Inherited from IMailService.)
Public methodDisconnectAsync
Asynchronously disconnect the service.
(Inherited from IMailService.)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodEnableQuickResync
Enable the quick resynchronization feature.
(Inherited from IMailStore.)
Public methodEnableQuickResyncAsync
Asynchronously enable the quick resynchronization feature.
(Inherited from IMailStore.)
Public methodEnableUTF8
Enable the UTF8=ACCEPT extension.
Public methodEnableUTF8Async
Asynchronously enable the UTF8=ACCEPT extension.
Public methodGetFolder(FolderNamespace)
Get the folder for the specified namespace.
(Inherited from IMailStore.)
Public methodGetFolder(SpecialFolder)
Get the specified special folder.
(Inherited from IMailStore.)
Public methodGetFolder(String, CancellationToken)
Get the folder for the specified path.
(Inherited from IMailStore.)
Public methodGetFolderAsync
Asynchronously get the folder for the specified path.
(Inherited from IMailStore.)
Public methodGetFolders(FolderNamespace, Boolean, CancellationToken)
Get all of the folders within the specified namespace.
(Inherited from IMailStore.)
Public methodGetFolders(FolderNamespace, StatusItems, Boolean, CancellationToken)
Get all of the folders within the specified namespace.
(Inherited from IMailStore.)
Public methodGetFoldersAsync(FolderNamespace, Boolean, CancellationToken)
Asynchronously get all of the folders within the specified namespace.
(Inherited from IMailStore.)
Public methodGetFoldersAsync(FolderNamespace, StatusItems, Boolean, CancellationToken)
Asynchronously get all of the folders within the specified namespace.
(Inherited from IMailStore.)
Public methodGetMetadata(MetadataTag, CancellationToken)
Gets the specified metadata.
(Inherited from IMailStore.)
Public methodGetMetadata(IEnumerableMetadataTag, CancellationToken)
Gets the specified metadata.
(Inherited from IMailStore.)
Public methodGetMetadata(MetadataOptions, IEnumerableMetadataTag, CancellationToken)
Gets the specified metadata.
(Inherited from IMailStore.)
Public methodGetMetadataAsync(MetadataTag, CancellationToken)
Asynchronously gets the specified metadata.
(Inherited from IMailStore.)
Public methodGetMetadataAsync(IEnumerableMetadataTag, CancellationToken)
Asynchronously gets the specified metadata.
(Inherited from IMailStore.)
Public methodGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken)
Asynchronously gets the specified metadata.
(Inherited from IMailStore.)
Public methodCode exampleIdentify
Identify the client implementation to the server and obtain the server implementation details.
Public methodIdentifyAsync
Asynchronously identify the client implementation to the server and obtain the server implementation details.
Public methodCode exampleIdle
Toggle the ImapClient into the IDLE state.
Public methodIdleAsync
Asynchronously toggle the ImapClient into the IDLE state.
Public methodNoOp
Ping the message service to keep the connection alive.
(Inherited from IMailService.)
Public methodNoOpAsync
Asynchronously ping the mail server to keep the connection alive.
(Inherited from IMailService.)
Public methodNotify
Request the specified notification events from the IMAP server.
Public methodNotifyAsync
Asynchronously request the specified notification events from the IMAP server.
Public methodSetMetadata
Sets the specified metadata.
(Inherited from IMailStore.)
Public methodSetMetadataAsync
Asynchronously sets the specified metadata.
(Inherited from IMailStore.)
Top
Events
  NameDescription
Public eventAlert
Occurs when a remote message store receives an alert message from the server.
(Inherited from IMailStore.)
Public eventAuthenticated
Occurs when the client has been successfully authenticated.
(Inherited from IMailService.)
Public eventConnected
Occurs when the client has been successfully connected.
(Inherited from IMailService.)
Public eventDisconnected
Occurs when the client has been disconnected.
(Inherited from IMailService.)
Public eventFolderCreated
Occurs when a folder is created.
(Inherited from IMailStore.)
Public eventMetadataChanged
Occurs when metadata changes.
(Inherited from IMailStore.)
Top
Remarks
Implemented by ImapClient.
See Also