Interface IAsyncImapClient

IAsyncImapClient interface

Allows applications to access and manipulate messages by using the Internet Message Access Protocol (IMAP).

public interface IAsyncImapClient

Methods

NameDescription
AddMessageFlagsAsync(ImapChangeMessageFlags)Adds the flags to the message
AppendMessageAsync(MailMessage, string, IConnection, CancellationToken)Uploads the mail message to the specified folder
AppendMessagesAsync(IEnumerable<MailMessage>, string, IConnection, CancellationToken)Uploads the mail messages to the current folder
BackupAsync(ImapFolderInfoCollection, Stream, BackupSettings, IConnection, CancellationToken)Backups the content of the specified folders
BackupAsync(ImapFolderInfoCollection, string, BackupSettings, IConnection, CancellationToken)Backups the content of the specified folders
ChangeMessageFlagsAsync(ImapChangeMessageFlags)Changes the flags of the message
ClientCapabilitiesAsync(IEnumerable<string>, IConnection, CancellationToken)Notifies server which extensions are supported by client. Please note, this operation works only in case if server supports RFC5161 See more https://tools.ietf.org/html/rfc5161
CommitDeletesAsync(ImapUniqueIdParameterSet)Commit the deletions
CopyMessageAsync(int, string, IConnection, CancellationToken)Copies the message
CopyMessageAsync(string, string, IConnection, CancellationToken)Copies the message.
CopyMessagesAsync(ImapCopyMessages)Copy the messages.
CreateFolderAsync(string, IConnection, CancellationToken)Creates a folder with the specified name.
DeleteFolderAsync(string, IConnection, CancellationToken)Deletes a specified folder. This method represents IMAP DELETE command.
DeleteMessagesAsync(ImapDeleteMessages)Marks a message with the specified unique identifier as deleted and commits the deletions if user specifies this. This method works only if server supports UIDPLUS extension. Please, read more https://tools.ietf.org/html/rfc4315
ExistFolderAsync(string, IConnection, CancellationToken)Check whether this folder exists
FetchAttachmentAsync(int, string, IConnection, CancellationToken)Fetches the specified attachment.
FetchMessagesAsync(ImapFetchMessages)Fetches the messages asynchronously
GetFolderInfoAsync(string, IConnection, CancellationToken)Returns information about the specified folder without selecting it
GetMessageThreadsAsync(BaseSearchConditions, IConnection, CancellationToken)Get message threads.
GetNamespacesAsync(IConnection, CancellationToken)Gets namespaces that are available on a server.
GetQuotaAsync(string, IConnection, CancellationToken)Gets quota information
GetQuotaRootAsync(string, IConnection, CancellationToken)Gets quota root information for mailbox
IntroduceClientAsync(ImapIdentificationInfo, IConnection, CancellationToken)Introduces client information to a server.
ListFoldersAsync(string, bool, ListFoldersOptions, ListFoldersReturnOptions, IConnection, CancellationToken)Gets the list of subfolders in the specified folder
ListMessageAsync(int, IEnumerable<string>, IConnection, CancellationToken)Gets information about a message.
ListMessageAsync(string, IEnumerable<string>, IConnection, CancellationToken)Gets information about a message.
ListMessagesAsync(MailQuery, string, int, IConnection, CancellationToken)Gets the list of messages in the current folder.
ListMessagesAsync(string, long, bool, IEnumerable<string>, IConnection, CancellationToken)Gets the list of messages in the specified folder
ListMessagesByPageAsync(int, int, PageSettings, CancellationToken)Gets the list of messages
ListMessagesByPageAsync(MailQuery, PageInfo, PageSettings, CancellationToken)Gets the list of messages
MoveFolderAsync(string, string, IConnection, CancellationToken)Moves specified folder and its subfolders to new location.
MoveMessagesAsync(ImapMoveMessages)Moves the messages.
NoopAsync(IConnection, CancellationToken)‘No operation’ command
RemoveMessageFlagsAsync(ImapChangeMessageFlags)Removes the flags of the message
RenameFolderAsync(string, string, IConnection, CancellationToken)Renames a specified folder to a new name
RequestCheckpointAsync(IConnection, CancellationToken)Requests a checkpoint of the currently selected mailbox.
RestoreAsync(PersonalStorage, RestoreSettings, CancellationToken)Begins to restore imap folders from the given personal storage.
ResumeMonitoringAsync(ImapMonitoringEventHandler, ImapMonitoringErrorEventHandler, IImapMonitoringState, CancellationToken)Resumes monitoring of message changes for specified folder. Unlike the StartMonitoring method, it will find all missing mailbox changes and call the callback for them.
SelectFolderAsync(string, bool?, IConnection, CancellationToken)Selects the specified folder
SetQuotaAsync(string, string, int, IConnection, CancellationToken)Sets quota information
SortMessageThreadsAsync(SortConditions, IConnection, CancellationToken)Sort message threads.
StartMonitoringAsync(ImapMonitoringEventHandler, ImapMonitoringErrorEventHandler, string)Starts monitoring of message changes for specified folder.
StopMonitoringAsync(string, CancellationToken)Stops monitoring of message changes for specified folder. Stops monitoring of all folders if folderName is null.
SubscribeFolderAsync(string, IConnection, CancellationToken)Sent the SUBSCRIBE command that adds the specified mailbox name to the server’s set of “active” mailboxes.
UndeleteMessageAsync(int, long, IConnection, CancellationToken)Marks a message with the specified sequence number as not deleted
UndeleteMessageAsync(string, long, IConnection, CancellationToken)Marks a message with the specified sequence number as not deleted.
UnselectFolderAsync(bool, IConnection, CancellationToken)Unselects folder which are currently selected. if doNotExpunge property is true, all messages are marked as deleted are removed, otherwise deletion canceled. Please note, this operation works only in case if server supports RFC3691 See more https://tools.ietf.org/html/rfc3691
UnsubscribeFolderAsync(string, IConnection, CancellationToken)Sent the UNSUBSCRIBE command that removes the specified mailbox name from the server’s set of “active” mailboxes
ValidateCredentialsAsync(IConnection, CancellationToken)Executes credentials validation

See Also