Click or drag to resize
MimeKit

ImapClient Methods

The ImapClient type exposes the following members.

Methods
 NameDescription
Public methodAuthenticate(ICredentials, CancellationToken) Authenticate using the supplied credentials.
(Inherited from MailService)
Public methodAuthenticate(SaslMechanism, CancellationToken) Authenticate using the specified SASL mechanism.
(Overrides MailServiceAuthenticate(SaslMechanism, CancellationToken))
Public methodAuthenticate(Encoding, ICredentials, CancellationToken) Authenticate using the supplied credentials.
(Overrides MailServiceAuthenticate(Encoding, ICredentials, CancellationToken))
Public methodCode exampleAuthenticate(String, String, CancellationToken) Authenticate using the specified user name and password.
(Inherited from MailService)
Public methodAuthenticate(Encoding, String, String, CancellationToken) Authenticate using the specified user name and password.
(Inherited from MailService)
Public methodAuthenticateAsync(ICredentials, CancellationToken) Asynchronously authenticate using the supplied credentials.
(Inherited from MailService)
Public methodAuthenticateAsync(SaslMechanism, CancellationToken) Asynchronously authenticate using the specified SASL mechanism.
(Overrides MailServiceAuthenticateAsync(SaslMechanism, CancellationToken))
Public methodAuthenticateAsync(Encoding, ICredentials, CancellationToken) Asynchronously authenticate using the supplied credentials.
(Overrides MailServiceAuthenticateAsync(Encoding, ICredentials, CancellationToken))
Public methodAuthenticateAsync(String, String, CancellationToken) Asynchronously authenticate using the specified user name and password.
(Inherited from MailService)
Public methodAuthenticateAsync(Encoding, String, String, CancellationToken) Asynchronously authenticate using the specified user name and password.
(Inherited from MailService)
Public methodCompress Enable compression over the IMAP connection.
Public methodCompressAsync Asynchronously enable compression over the IMAP connection.
Public methodCode exampleConnect(Uri, CancellationToken) Establish a connection to the specified mail server.
(Inherited from MailService)
Public methodConnect(String, Int32, Boolean, CancellationToken) Establish a connection to the specified mail server.
(Inherited from MailService)
Public methodCode exampleConnect(String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified IMAP server.
(Overrides MailServiceConnect(String, Int32, SecureSocketOptions, CancellationToken))
Public methodConnect(Socket, String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified IMAP or IMAP/S server using the provided socket.
(Overrides MailServiceConnect(Socket, String, Int32, SecureSocketOptions, CancellationToken))
Public methodConnect(Stream, String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified IMAP or IMAP/S server using the provided stream.
(Overrides MailServiceConnect(Stream, String, Int32, SecureSocketOptions, CancellationToken))
Public methodConnectAsync(Uri, CancellationToken) Asynchronously establish a connection to the specified mail server.
(Inherited from MailService)
Public methodConnectAsync(String, Int32, Boolean, CancellationToken) Asynchronously establish a connection to the specified mail server.
(Inherited from MailService)
Public methodCode exampleConnectAsync(String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified IMAP server.
(Overrides MailServiceConnectAsync(String, Int32, SecureSocketOptions, CancellationToken))
Public methodConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified IMAP or IMAP/S server using the provided socket.
(Overrides MailServiceConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken))
Public methodConnectAsync(Stream, String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified IMAP or IMAP/S server using the provided stream.
(Overrides MailServiceConnectAsync(Stream, String, Int32, SecureSocketOptions, CancellationToken))
Protected methodCreateImapFolder Instantiate a new ImapFolder.
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 methodCode exampleDisconnect Disconnect the service.
(Overrides MailServiceDisconnect(Boolean, CancellationToken))
Public methodCode exampleDisconnectAsync Asynchronously disconnect the service.
(Overrides MailServiceDisconnectAsync(Boolean, CancellationToken))
Public methodDispose Releases all resource used by the MailService object.
(Inherited from MailService)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the ImapClient and optionally releases the managed resources.
(Overrides MailServiceDispose(Boolean))
Public methodEnableQuickResync Enable the QRESYNC feature.
(Overrides MailStoreEnableQuickResync(CancellationToken))
Public methodEnableQuickResyncAsync Asynchronously enable the QRESYNC feature.
(Overrides MailStoreEnableQuickResyncAsync(CancellationToken))
Public methodEnableUTF8 Enable the UTF8=ACCEPT extension.
Public methodEnableUTF8Async Asynchronously enable the UTF8=ACCEPT extension.
Public methodEquals
(Inherited from Object)
Protected methodFinalize Releases unmanaged resources and performs other cleanup operations before the MailService is reclaimed by garbage collection.
(Inherited from MailService)
Public methodCode exampleGetFolder(FolderNamespace) Get the folder for the specified namespace.
(Overrides MailStoreGetFolder(FolderNamespace))
Public methodGetFolder(SpecialFolder) Get the specified special folder.
(Overrides MailStoreGetFolder(SpecialFolder))
Public methodGetFolder(String, CancellationToken) Get the folder for the specified path.
(Overrides MailStoreGetFolder(String, CancellationToken))
Public methodGetFolderAsync Asynchronously get the folder for the specified path.
(Overrides MailStoreGetFolderAsync(String, CancellationToken))
Public methodGetFolders(FolderNamespace, Boolean, CancellationToken) Get all of the folders within the specified namespace.
(Inherited from MailStore)
Public methodGetFolders(FolderNamespace, StatusItems, Boolean, CancellationToken) Get all of the folders within the specified namespace.
(Overrides MailStoreGetFolders(FolderNamespace, StatusItems, Boolean, CancellationToken))
Public methodGetFoldersAsync(FolderNamespace, Boolean, CancellationToken) Asynchronously get all of the folders within the specified namespace.
(Inherited from MailStore)
Public methodGetFoldersAsync(FolderNamespace, StatusItems, Boolean, CancellationToken) Asynchronously get all of the folders within the specified namespace.
(Overrides MailStoreGetFoldersAsync(FolderNamespace, StatusItems, Boolean, CancellationToken))
Public methodGetHashCode
(Inherited from Object)
Public methodGetMetadata(IEnumerableMetadataTag, CancellationToken) Gets the specified metadata.
(Inherited from MailStore)
Public methodGetMetadata(MetadataTag, CancellationToken) Gets the specified metadata.
(Overrides MailStoreGetMetadata(MetadataTag, CancellationToken))
Public methodGetMetadata(MetadataOptions, IEnumerableMetadataTag, CancellationToken) Gets the specified metadata.
(Overrides MailStoreGetMetadata(MetadataOptions, IEnumerableMetadataTag, CancellationToken))
Public methodGetMetadataAsync(IEnumerableMetadataTag, CancellationToken) Asynchronously gets the specified metadata.
(Inherited from MailStore)
Public methodGetMetadataAsync(MetadataTag, CancellationToken) Asynchronously gets the specified metadata.
(Overrides MailStoreGetMetadataAsync(MetadataTag, CancellationToken))
Public methodGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken) Asynchronously gets the specified metadata.
(Overrides MailStoreGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken))
Public methodGetType
(Inherited from Object)
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.
Protected methodMemberwiseClone
(Inherited from Object)
Public methodCode exampleNoOp Ping the IMAP server to keep the connection alive.
(Overrides MailServiceNoOp(CancellationToken))
Public methodCode exampleNoOpAsync Asynchronously ping the IMAP server to keep the connection alive.
(Overrides MailServiceNoOpAsync(CancellationToken))
Public methodNotify Request the specified notification events from the IMAP server.
Public methodNotifyAsync Asynchronously request the specified notification events from the IMAP server.
Protected methodOnAlert Raise the alert event.
(Inherited from MailStore)
Protected methodOnAuthenticated Raise the authenticated event.
(Inherited from MailService)
Protected methodOnConnected Raise the connected event.
(Inherited from MailService)
Protected methodOnDisconnected Raise the disconnected event.
(Inherited from MailService)
Protected methodOnFolderCreated Raise the folder created event.
(Inherited from MailStore)
Protected methodOnMetadataChanged Raise the metadata changed event.
(Inherited from MailStore)
Protected methodOnWebAlert Raise the web alert event.
Public methodSetMetadata Sets the specified metadata.
(Overrides MailStoreSetMetadata(MetadataCollection, CancellationToken))
Public methodSetMetadataAsync Asynchronously gets the specified metadata.
(Overrides MailStoreSetMetadataAsync(MetadataCollection, CancellationToken))
Public methodToString
(Inherited from Object)
Top
See Also