Click or drag to resize
MimeKit

IMailFolder Interface

An interface for a mailbox folder as used by IMailStore.

Namespace:  MailKit
Assembly:  MailKit (in MailKit.dll) Version: 2.10.0
Syntax
C#
public interface IMailFolder : IEnumerable<MimeMessage>, 
	IEnumerable

The IMailFolder type exposes the following members.

Properties
  NameDescription
Public propertyAcceptedFlags
Get the accepted flags.
Public propertyAccess
Get the read/write access of the folder.
Public propertyAnnotationAccess
Get the annotation access level.
Public propertyAnnotationScopes
Get the supported annotation scopes.
Public propertyAppendLimit
Get the maximum size of a message that can be appended to the folder.
Public propertyAttributes
Get the folder attributes.
Public propertyCount
Get the total number of messages in the folder.
Public propertyDirectorySeparator
Get the directory separator.
Public propertyExists
Get whether or not the folder exists.
Public propertyFirstUnread
Get the index of the first unread message in the folder.
Public propertyFullName
Get the full name of the folder.
Public propertyHighestModSeq
Get the highest mod-sequence value of all messages in the mailbox.
Public propertyId
Get the unique identifier for the folder, if available.
Public propertyIsNamespace
Get whether or not the folder is a namespace folder.
Public propertyIsOpen
Get whether or not the folder is currently open.
Public propertyIsSubscribed
Get whether or not the folder is subscribed.
Public propertyMaxAnnotationSize
Get the maximum size of annotation values supported by the folder.
Public propertyName
Get the name of the folder.
Public propertyParentFolder
Get the parent folder.
Public propertyPermanentFlags
Get the permanent flags.
Public propertyRecent
Get the number of recently delivered messages in the folder.
Public propertySize
Get the size of the folder.
Public propertySupportsModSeq Obsolete.
Get whether or not the folder supports mod-sequences.
Public propertySyncRoot
Gets an object that can be used to synchronize access to the folder.
Public propertyThreadingAlgorithms
Get the threading algorithms supported by the folder.
Public propertyUidNext
Get the UID that the next message that is added to the folder will be assigned.
Public propertyUidValidity
Get the Unique ID validity.
Public propertyUnread
Get the number of unread messages in the folder.
Top
Methods
  NameDescription
Public methodAddAccessRights
Add access rights for the specified identity.
Public methodAddAccessRightsAsync
Asynchronously add access rights for the specified identity.
Public methodAddFlags(IListInt32, MessageFlags, Boolean, CancellationToken)
Add a set of flags to the specified messages.
Public methodAddFlags(Int32, MessageFlags, Boolean, CancellationToken)
Add a set of flags to the specified message.
Public methodAddFlags(UniqueId, MessageFlags, Boolean, CancellationToken)
Add a set of flags to the specified message.
Public methodAddFlags(IListUniqueId, MessageFlags, Boolean, CancellationToken)
Add a set of flags to the specified messages.
Public methodAddFlags(IListInt32, MessageFlags, HashSetString, Boolean, CancellationToken)
Add a set of flags to the specified messages.
Public methodAddFlags(IListInt32, UInt64, MessageFlags, Boolean, CancellationToken)
Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAddFlags(Int32, MessageFlags, HashSetString, Boolean, CancellationToken)
Add a set of flags to the specified message.
Public methodAddFlags(UniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Add a set of flags to the specified message.
Public methodAddFlags(IListUniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Add a set of flags to the specified messages.
Public methodAddFlags(IListUniqueId, UInt64, MessageFlags, Boolean, CancellationToken)
Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAddFlags(IListInt32, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAddFlags(IListUniqueId, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAddFlagsAsync(IListInt32, MessageFlags, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified messages.
Public methodAddFlagsAsync(Int32, MessageFlags, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified message.
Public methodAddFlagsAsync(UniqueId, MessageFlags, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified message.
Public methodAddFlagsAsync(IListUniqueId, MessageFlags, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified messages.
Public methodAddFlagsAsync(IListInt32, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified messages.
Public methodAddFlagsAsync(IListInt32, UInt64, MessageFlags, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAddFlagsAsync(Int32, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified message.
Public methodAddFlagsAsync(UniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified message.
Public methodAddFlagsAsync(IListUniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified messages.
Public methodAddFlagsAsync(IListUniqueId, UInt64, MessageFlags, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAddFlagsAsync(IListInt32, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAddFlagsAsync(IListUniqueId, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAddLabels(IListInt32, IListString, Boolean, CancellationToken)
Add a set of labels to the specified messages.
Public methodAddLabels(Int32, IListString, Boolean, CancellationToken)
Add a set of labels to the specified message.
Public methodAddLabels(UniqueId, IListString, Boolean, CancellationToken)
Add a set of labels to the specified message.
Public methodAddLabels(IListUniqueId, IListString, Boolean, CancellationToken)
Add a set of labels to the specified messages.
Public methodAddLabels(IListInt32, UInt64, IListString, Boolean, CancellationToken)
Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAddLabels(IListUniqueId, UInt64, IListString, Boolean, CancellationToken)
Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAddLabelsAsync(IListInt32, IListString, Boolean, CancellationToken)
Asynchronously add a set of labels to the specified messages.
Public methodAddLabelsAsync(Int32, IListString, Boolean, CancellationToken)
Asynchronously add a set of labels to the specified message.
Public methodAddLabelsAsync(UniqueId, IListString, Boolean, CancellationToken)
Asynchronously add a set of labels to the specified message.
Public methodAddLabelsAsync(IListUniqueId, IListString, Boolean, CancellationToken)
Asynchronously add a set of labels to the specified messages.
Public methodAddLabelsAsync(IListInt32, UInt64, IListString, Boolean, CancellationToken)
Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAddLabelsAsync(IListUniqueId, UInt64, IListString, Boolean, CancellationToken)
Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
Public methodAppend(MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Append the specified message to the folder.
Public methodAppend(IListMimeMessage, IListMessageFlags, CancellationToken, ITransferProgress)
Append the specified messages to the folder.
Public methodAppend(FormatOptions, MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Append the specified message to the folder.
Public methodAppend(FormatOptions, IListMimeMessage, IListMessageFlags, CancellationToken, ITransferProgress)
Append the specified messages to the folder.
Public methodAppend(MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Append the specified message to the folder.
Public methodAppend(IListMimeMessage, IListMessageFlags, IListDateTimeOffset, CancellationToken, ITransferProgress)
Append the specified messages to the folder.
Public methodAppend(FormatOptions, MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Append the specified message to the folder.
Public methodAppend(FormatOptions, IListMimeMessage, IListMessageFlags, IListDateTimeOffset, CancellationToken, ITransferProgress)
Append the specified messages to the folder.
Public methodAppend(MimeMessage, MessageFlags, NullableDateTimeOffset, IListAnnotation, CancellationToken, ITransferProgress)
Append the specified message to the folder.
Public methodAppend(FormatOptions, MimeMessage, MessageFlags, NullableDateTimeOffset, IListAnnotation, CancellationToken, ITransferProgress)
Append the specified message to the folder.
Public methodAppendAsync(MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Asynchronously append the specified message to the folder.
Public methodAppendAsync(IListMimeMessage, IListMessageFlags, CancellationToken, ITransferProgress)
Asynchronously append the specified messages to the folder.
Public methodAppendAsync(FormatOptions, MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Asynchronously append the specified message to the folder.
Public methodAppendAsync(FormatOptions, IListMimeMessage, IListMessageFlags, CancellationToken, ITransferProgress)
Asynchronously append the specified messages to the folder.
Public methodAppendAsync(MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Asynchronously append the specified message to the folder.
Public methodAppendAsync(IListMimeMessage, IListMessageFlags, IListDateTimeOffset, CancellationToken, ITransferProgress)
Asynchronously append the specified messages to the folder.
Public methodAppendAsync(FormatOptions, MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Asynchronously append the specified message to the folder.
Public methodAppendAsync(FormatOptions, IListMimeMessage, IListMessageFlags, IListDateTimeOffset, CancellationToken, ITransferProgress)
Asynchronously append the specified messages to the folder.
Public methodAppendAsync(MimeMessage, MessageFlags, NullableDateTimeOffset, IListAnnotation, CancellationToken, ITransferProgress)
Asynchronously append the specified message to the folder.
Public methodAppendAsync(FormatOptions, MimeMessage, MessageFlags, NullableDateTimeOffset, IListAnnotation, CancellationToken, ITransferProgress)
Asynchronously append the specified message to the folder.
Public methodCheck
Force the server to flush its state for the folder.
Public methodCheckAsync
Asynchronously force the server to flush its state for the folder.
Public methodClose
Close the folder, optionally expunging the messages marked for deletion.
Public methodCloseAsync
Asynchronously close the folder, optionally expunging the messages marked for deletion.
Public methodCopyTo(IListInt32, IMailFolder, CancellationToken)
Copy the specified messages to the destination folder.
Public methodCopyTo(Int32, IMailFolder, CancellationToken)
Copy the specified message to the destination folder.
Public methodCopyTo(UniqueId, IMailFolder, CancellationToken)
Copy the specified message to the destination folder.
Public methodCopyTo(IListUniqueId, IMailFolder, CancellationToken)
Copy the specified messages to the destination folder.
Public methodCopyToAsync(IListInt32, IMailFolder, CancellationToken)
Asynchronously copy the specified messages to the destination folder.
Public methodCopyToAsync(Int32, IMailFolder, CancellationToken)
Asynchronously copy the specified message to the destination folder.
Public methodCopyToAsync(UniqueId, IMailFolder, CancellationToken)
Asynchronously copy the specified message to the destination folder.
Public methodCopyToAsync(IListUniqueId, IMailFolder, CancellationToken)
Asynchronously copy the specified messages to the destination folder.
Public methodCreate(String, SpecialFolder, CancellationToken)
Create a new subfolder with the given name.
Public methodCreate(String, Boolean, CancellationToken)
Create a new subfolder with the given name.
Public methodCreate(String, IEnumerableSpecialFolder, CancellationToken)
Create a new subfolder with the given name.
Public methodCreateAsync(String, SpecialFolder, CancellationToken)
Asynchronously create a new subfolder with the given name.
Public methodCreateAsync(String, Boolean, CancellationToken)
Asynchronously create a new subfolder with the given name.
Public methodCreateAsync(String, IEnumerableSpecialFolder, CancellationToken)
Asynchronously create a new subfolder with the given name.
Public methodDelete
Delete the folder.
Public methodDeleteAsync
Asynchronously delete the folder.
Public methodExpunge(CancellationToken)
Expunge the folder, permanently removing all messages marked for deletion.
Public methodExpunge(IListUniqueId, CancellationToken)
Expunge the specified uids, permanently removing them from the folder.
Public methodExpungeAsync(CancellationToken)
Asynchronously expunge the folder, permanently removing all messages marked for deletion.
Public methodExpungeAsync(IListUniqueId, CancellationToken)
Asynchronously expunge the specified uids, permanently removing them from the folder.
Public methodFetch(IListInt32, MessageSummaryItems, CancellationToken)
Fetch the message summaries for the specified message indexes.
Public methodCode exampleFetch(IListUniqueId, MessageSummaryItems, CancellationToken)
Fetch the message summaries for the specified message UIDs.
Public methodFetch(IListInt32, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Fetch the message summaries for the specified message indexes.
Public methodFetch(IListInt32, MessageSummaryItems, IEnumerableString, CancellationToken)
Fetch the message summaries for the specified message indexes.
Public methodFetch(IListInt32, UInt64, MessageSummaryItems, CancellationToken)
Fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.
Public methodFetch(Int32, Int32, MessageSummaryItems, CancellationToken)
Fetch the message summaries for the messages between the two indexes, inclusive.
Public methodFetch(IListUniqueId, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Fetch the message summaries for the specified message UIDs.
Public methodFetch(IListUniqueId, MessageSummaryItems, IEnumerableString, CancellationToken)
Fetch the message summaries for the specified message UIDs.
Public methodFetch(IListUniqueId, UInt64, MessageSummaryItems, CancellationToken)
Fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.
Public methodFetch(IListInt32, UInt64, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.
Public methodFetch(IListInt32, UInt64, MessageSummaryItems, IEnumerableString, CancellationToken)
Fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.
Public methodFetch(Int32, Int32, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Fetch the message summaries for the messages between the two indexes, inclusive.
Public methodFetch(Int32, Int32, MessageSummaryItems, IEnumerableString, CancellationToken)
Fetch the message summaries for the messages between the two indexes, inclusive.
Public methodFetch(Int32, Int32, UInt64, MessageSummaryItems, CancellationToken)
Fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.
Public methodFetch(IListUniqueId, UInt64, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.
Public methodFetch(IListUniqueId, UInt64, MessageSummaryItems, IEnumerableString, CancellationToken)
Fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.
Public methodFetch(Int32, Int32, UInt64, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.
Public methodFetch(Int32, Int32, UInt64, MessageSummaryItems, IEnumerableString, CancellationToken)
Fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.
Public methodFetchAsync(IListInt32, MessageSummaryItems, CancellationToken)
Asynchronously fetch the message summaries for the specified message indexes.
Public methodFetchAsync(IListUniqueId, MessageSummaryItems, CancellationToken)
Asynchronously fetch the message summaries for the specified message UIDs.
Public methodFetchAsync(IListInt32, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Asynchronously fetch the message summaries for the specified message indexes.
Public methodFetchAsync(IListInt32, MessageSummaryItems, IEnumerableString, CancellationToken)
Asynchronously fetch the message summaries for the specified message indexes.
Public methodFetchAsync(IListInt32, UInt64, MessageSummaryItems, CancellationToken)
Asynchronously fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.
Public methodFetchAsync(Int32, Int32, MessageSummaryItems, CancellationToken)
Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
Public methodFetchAsync(IListUniqueId, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Asynchronously fetch the message summaries for the specified message UIDs.
Public methodFetchAsync(IListUniqueId, MessageSummaryItems, IEnumerableString, CancellationToken)
Asynchronously fetch the message summaries for the specified message UIDs.
Public methodFetchAsync(IListUniqueId, UInt64, MessageSummaryItems, CancellationToken)
Asynchronously fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.
Public methodFetchAsync(IListInt32, UInt64, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Asynchronously fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.
Public methodFetchAsync(IListInt32, UInt64, MessageSummaryItems, IEnumerableString, CancellationToken)
Asynchronously fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.
Public methodFetchAsync(Int32, Int32, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
Public methodFetchAsync(Int32, Int32, MessageSummaryItems, IEnumerableString, CancellationToken)
Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
Public methodFetchAsync(Int32, Int32, UInt64, MessageSummaryItems, CancellationToken)
Asynchronously fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.
Public methodFetchAsync(IListUniqueId, UInt64, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Asynchronously fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.
Public methodFetchAsync(IListUniqueId, UInt64, MessageSummaryItems, IEnumerableString, CancellationToken)
Asynchronously fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.
Public methodFetchAsync(Int32, Int32, UInt64, MessageSummaryItems, IEnumerableHeaderId, CancellationToken)
Asynchronously fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.
Public methodFetchAsync(Int32, Int32, UInt64, MessageSummaryItems, IEnumerableString, CancellationToken)
Asynchronously fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.
Public methodGetAccessControlList
Get the complete access control list for the folder.
Public methodGetAccessControlListAsync
Asynchronously get the complete access control list for the folder.
Public methodGetAccessRights
Get the access rights for a particular identifier.
Public methodGetAccessRightsAsync
Asynchronously get the access rights for a particular identifier.
Public methodGetBodyPart(Int32, BodyPart, CancellationToken, ITransferProgress)
Get the specified body part.
Public methodCode exampleGetBodyPart(UniqueId, BodyPart, CancellationToken, ITransferProgress)
Get the specified body part.
Public methodGetBodyPartAsync(Int32, BodyPart, CancellationToken, ITransferProgress)
Asynchronously get the specified body part.
Public methodGetBodyPartAsync(UniqueId, BodyPart, CancellationToken, ITransferProgress)
Asynchronously get the specified body part.
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
(Inherited from IEnumerableMimeMessage.)
Public methodGetHeaders(Int32, CancellationToken, ITransferProgress)
Get the specified message headers.
Public methodGetHeaders(UniqueId, CancellationToken, ITransferProgress)
Get the specified message headers.
Public methodGetHeaders(Int32, BodyPart, CancellationToken, ITransferProgress)
Get the specified body part headers.
Public methodGetHeaders(UniqueId, BodyPart, CancellationToken, ITransferProgress)
Get the specified body part headers.
Public methodGetHeadersAsync(Int32, CancellationToken, ITransferProgress)
Asynchronously get the specified message headers.
Public methodGetHeadersAsync(UniqueId, CancellationToken, ITransferProgress)
Asynchronously get the specified message headers.
Public methodGetHeadersAsync(Int32, BodyPart, CancellationToken, ITransferProgress)
Asynchronously get the specified body part headers.
Public methodGetHeadersAsync(UniqueId, BodyPart, CancellationToken, ITransferProgress)
Asynchronously get the specified body part headers.
Public methodGetMessage(Int32, CancellationToken, ITransferProgress)
Get the specified message.
Public methodGetMessage(UniqueId, CancellationToken, ITransferProgress)
Get the specified message.
Public methodGetMessageAsync(Int32, CancellationToken, ITransferProgress)
Asynchronously get the specified message.
Public methodGetMessageAsync(UniqueId, CancellationToken, ITransferProgress)
Asynchronously get the specified message.
Public methodGetMetadata(MetadataTag, CancellationToken)
Gets the specified metadata.
Public methodGetMetadata(IEnumerableMetadataTag, CancellationToken)
Gets the specified metadata.
Public methodGetMetadata(MetadataOptions, IEnumerableMetadataTag, CancellationToken)
Gets the specified metadata.
Public methodGetMetadataAsync(MetadataTag, CancellationToken)
Asynchronously gets the specified metadata.
Public methodGetMetadataAsync(IEnumerableMetadataTag, CancellationToken)
Asynchronously gets the specified metadata.
Public methodGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken)
Asynchronously gets the specified metadata.
Public methodGetMyAccessRights
Get the access rights for the current authenticated user.
Public methodGetMyAccessRightsAsync
Asynchronously get the access rights for the current authenticated user.
Public methodGetQuota
Get the quota information for the folder.
Public methodGetQuotaAsync
Asynchronously get the quota information for the folder.
Public methodGetStream(Int32, String, CancellationToken, ITransferProgress)
Get a substream of the specified message.
Public methodGetStream(UniqueId, String, CancellationToken, ITransferProgress)
Get a substream of the specified message.
Public methodGetStream(Int32, Int32, Int32, CancellationToken, ITransferProgress)
Get a substream of the specified message.
Public methodGetStream(UniqueId, Int32, Int32, CancellationToken, ITransferProgress)
Get a substream of the specified message.
Public methodGetStream(Int32, BodyPart, Int32, Int32, CancellationToken, ITransferProgress)
Get a substream of the specified body part.
Public methodGetStream(Int32, String, Int32, Int32, CancellationToken, ITransferProgress)
Get a substream of the specified message.
Public methodGetStream(UniqueId, BodyPart, Int32, Int32, CancellationToken, ITransferProgress)
Get a substream of the specified body part.
Public methodGetStream(UniqueId, String, Int32, Int32, CancellationToken, ITransferProgress)
Get a substream of the specified message.
Public methodGetStreamAsync(Int32, String, CancellationToken, ITransferProgress)
Asynchronously get a substream of the specified message.
Public methodGetStreamAsync(UniqueId, String, CancellationToken, ITransferProgress)
Asynchronously get a substream of the specified message.
Public methodGetStreamAsync(Int32, Int32, Int32, CancellationToken, ITransferProgress)
Asynchronously get a substream of the specified message.
Public methodGetStreamAsync(UniqueId, Int32, Int32, CancellationToken, ITransferProgress)
Asynchronously get a substream of the specified message.
Public methodGetStreamAsync(Int32, BodyPart, Int32, Int32, CancellationToken, ITransferProgress)
Asynchronously get a substream of the specified body part.
Public methodGetStreamAsync(Int32, String, Int32, Int32, CancellationToken, ITransferProgress)
Asynchronously get a substream of the specified message.
Public methodGetStreamAsync(UniqueId, BodyPart, Int32, Int32, CancellationToken, ITransferProgress)
Asynchronously get a substream of the specified body part.
Public methodGetStreamAsync(UniqueId, String, Int32, Int32, CancellationToken, ITransferProgress)
Asynchronously get a substream of the specified message.
Public methodGetSubfolder
Get the specified subfolder.
Public methodGetSubfolderAsync
Asynchronously get the specified subfolder.
Public methodGetSubfolders(Boolean, CancellationToken)
Get the subfolders.
Public methodGetSubfolders(StatusItems, Boolean, CancellationToken)
Get the subfolders.
Public methodGetSubfoldersAsync(Boolean, CancellationToken)
Asynchronously get the subfolders.
Public methodGetSubfoldersAsync(StatusItems, Boolean, CancellationToken)
Asynchronously get the subfolders.
Public methodMoveTo(IListInt32, IMailFolder, CancellationToken)
Move the specified messages to the destination folder.
Public methodMoveTo(Int32, IMailFolder, CancellationToken)
Move the specified message to the destination folder.
Public methodMoveTo(UniqueId, IMailFolder, CancellationToken)
Move the specified message to the destination folder.
Public methodMoveTo(IListUniqueId, IMailFolder, CancellationToken)
Move the specified messages to the destination folder.
Public methodMoveToAsync(IListInt32, IMailFolder, CancellationToken)
Asynchronously move the specified messages to the destination folder.
Public methodMoveToAsync(Int32, IMailFolder, CancellationToken)
Asynchronously move the specified message to the destination folder.
Public methodMoveToAsync(UniqueId, IMailFolder, CancellationToken)
Asynchronously move the specified message to the destination folder.
Public methodMoveToAsync(IListUniqueId, IMailFolder, CancellationToken)
Asynchronously move the specified messages to the destination folder.
Public methodOpen(FolderAccess, CancellationToken)
Open the folder using the requested folder access.
Public methodOpen(FolderAccess, UInt32, UInt64, IListUniqueId, CancellationToken)
Opens the folder using the requested folder access.
Public methodOpenAsync(FolderAccess, CancellationToken)
Asynchronously open the folder using the requested folder access.
Public methodOpenAsync(FolderAccess, UInt32, UInt64, IListUniqueId, CancellationToken)
Asynchronously opens the folder using the requested folder access.
Public methodRemoveAccess
Remove all access rights for the given identity.
Public methodRemoveAccessAsync
Asynchronously remove all access rights for the given identity.
Public methodRemoveAccessRights
Remove access rights for the specified identity.
Public methodRemoveAccessRightsAsync
Asynchronously remove access rights for the specified identity.
Public methodRemoveFlags(IListInt32, MessageFlags, Boolean, CancellationToken)
Remove a set of flags from the specified messages.
Public methodRemoveFlags(Int32, MessageFlags, Boolean, CancellationToken)
Remove a set of flags from the specified message.
Public methodRemoveFlags(UniqueId, MessageFlags, Boolean, CancellationToken)
Remove a set of flags from the specified message.
Public methodRemoveFlags(IListUniqueId, MessageFlags, Boolean, CancellationToken)
Remove a set of flags from the specified messages.
Public methodRemoveFlags(IListInt32, MessageFlags, HashSetString, Boolean, CancellationToken)
Remove a set of flags from the specified messages.
Public methodRemoveFlags(IListInt32, UInt64, MessageFlags, Boolean, CancellationToken)
Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRemoveFlags(Int32, MessageFlags, HashSetString, Boolean, CancellationToken)
Remove a set of flags from the specified message.
Public methodRemoveFlags(UniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Remove a set of flags from the specified message.
Public methodRemoveFlags(IListUniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Remove a set of flags from the specified messages.
Public methodRemoveFlags(IListUniqueId, UInt64, MessageFlags, Boolean, CancellationToken)
Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRemoveFlags(IListInt32, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRemoveFlags(IListUniqueId, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRemoveFlagsAsync(IListInt32, MessageFlags, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified messages.
Public methodRemoveFlagsAsync(Int32, MessageFlags, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified message.
Public methodRemoveFlagsAsync(UniqueId, MessageFlags, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified message.
Public methodRemoveFlagsAsync(IListUniqueId, MessageFlags, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified messages.
Public methodRemoveFlagsAsync(IListInt32, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified messages.
Public methodRemoveFlagsAsync(IListInt32, UInt64, MessageFlags, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRemoveFlagsAsync(Int32, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified message.
Public methodRemoveFlagsAsync(UniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified message.
Public methodRemoveFlagsAsync(IListUniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified messages.
Public methodRemoveFlagsAsync(IListUniqueId, UInt64, MessageFlags, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRemoveFlagsAsync(IListInt32, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRemoveFlagsAsync(IListUniqueId, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRemoveLabels(IListInt32, IListString, Boolean, CancellationToken)
Remove a set of labels from the specified messages.
Public methodRemoveLabels(Int32, IListString, Boolean, CancellationToken)
Remove a set of labels from the specified message.
Public methodRemoveLabels(UniqueId, IListString, Boolean, CancellationToken)
Remove a set of labels from the specified message.
Public methodRemoveLabels(IListUniqueId, IListString, Boolean, CancellationToken)
Remove a set of labels from the specified messages.
Public methodRemoveLabels(IListInt32, UInt64, IListString, Boolean, CancellationToken)
Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRemoveLabels(IListUniqueId, UInt64, IListString, Boolean, CancellationToken)
Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRemoveLabelsAsync(IListInt32, IListString, Boolean, CancellationToken)
Asynchronously remove a set of labels from the specified messages.
Public methodRemoveLabelsAsync(Int32, IListString, Boolean, CancellationToken)
Asynchronously remove a set of labels from the specified message.
Public methodRemoveLabelsAsync(UniqueId, IListString, Boolean, CancellationToken)
Asynchronously remove a set of labels from the specified message.
Public methodRemoveLabelsAsync(IListUniqueId, IListString, Boolean, CancellationToken)
Asynchronously remove a set of labels from the specified messages.
Public methodRemoveLabelsAsync(IListInt32, UInt64, IListString, Boolean, CancellationToken)
Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRemoveLabelsAsync(IListUniqueId, UInt64, IListString, Boolean, CancellationToken)
Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
Public methodRename
Rename the folder.
Public methodRenameAsync
Asynchronously rename the folder.
Public methodReplace(Int32, MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Replace a message in the folder.
Public methodReplace(UniqueId, MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Replace a message in the folder.
Public methodReplace(Int32, MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Replace a message in the folder.
Public methodReplace(FormatOptions, UniqueId, MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Replace a message in the folder.
Public methodReplace(FormatOptions, Int32, MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Replace a message in the folder.
Public methodReplace(UniqueId, MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Replace a message in the folder.
Public methodReplace(FormatOptions, UniqueId, MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Replace a message in the folder.
Public methodReplace(FormatOptions, Int32, MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Replace a message in the folder.
Public methodReplaceAsync(Int32, MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Asynchronously replace a message in the folder.
Public methodReplaceAsync(UniqueId, MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Asynchronously replace a message in the folder.
Public methodReplaceAsync(Int32, MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Asynchronously replace a message in the folder.
Public methodReplaceAsync(FormatOptions, UniqueId, MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Asynchronously replace a message in the folder.
Public methodReplaceAsync(FormatOptions, Int32, MimeMessage, MessageFlags, CancellationToken, ITransferProgress)
Asynchronously replace a message in the folder.
Public methodReplaceAsync(UniqueId, MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Asynchronously replace a message in the folder.
Public methodReplaceAsync(FormatOptions, UniqueId, MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Asynchronously replace a message in the folder.
Public methodReplaceAsync(FormatOptions, Int32, MimeMessage, MessageFlags, DateTimeOffset, CancellationToken, ITransferProgress)
Asynchronously replace a message in the folder.
Public methodSearch(SearchQuery, CancellationToken)
Search the folder for messages matching the specified query.
Public methodSearch(SearchOptions, SearchQuery, CancellationToken)
Search the folder for messages matching the specified query.
Public methodSearch(IListUniqueId, SearchQuery, CancellationToken)
Search the subset of UIDs in the folder for messages matching the specified query.
Public methodSearch(SearchOptions, IListUniqueId, SearchQuery, CancellationToken)
Search the subset of UIDs in the folder for messages matching the specified query.
Public methodSearchAsync(SearchQuery, CancellationToken)
Asynchronously search the folder for messages matching the specified query.
Public methodSearchAsync(SearchOptions, SearchQuery, CancellationToken)
Asynchronously search the folder for messages matching the specified query.
Public methodSearchAsync(IListUniqueId, SearchQuery, CancellationToken)
Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
Public methodSearchAsync(SearchOptions, IListUniqueId, SearchQuery, CancellationToken)
Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
Public methodSetAccessRights
Set the access rights for the specified identity.
Public methodSetAccessRightsAsync
Asynchronously set the access rights for the sepcified identity.
Public methodSetFlags(IListInt32, MessageFlags, Boolean, CancellationToken)
Set the flags of the specified messages.
Public methodSetFlags(Int32, MessageFlags, Boolean, CancellationToken)
Set the flags of the specified message.
Public methodSetFlags(UniqueId, MessageFlags, Boolean, CancellationToken)
Set the flags of the specified message.
Public methodSetFlags(IListUniqueId, MessageFlags, Boolean, CancellationToken)
Set the flags of the specified messages.
Public methodSetFlags(IListInt32, MessageFlags, HashSetString, Boolean, CancellationToken)
Set the flags of the specified messages.
Public methodSetFlags(IListInt32, UInt64, MessageFlags, Boolean, CancellationToken)
Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetFlags(Int32, MessageFlags, HashSetString, Boolean, CancellationToken)
Set the flags of the specified message.
Public methodSetFlags(UniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Set the flags of the specified message.
Public methodSetFlags(IListUniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Set the flags of the specified messages.
Public methodSetFlags(IListUniqueId, UInt64, MessageFlags, Boolean, CancellationToken)
Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetFlags(IListInt32, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetFlags(IListUniqueId, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetFlagsAsync(IListInt32, MessageFlags, Boolean, CancellationToken)
Asynchronously set the flags of the specified messages.
Public methodSetFlagsAsync(Int32, MessageFlags, Boolean, CancellationToken)
Asynchronously set the flags of the specified message.
Public methodSetFlagsAsync(UniqueId, MessageFlags, Boolean, CancellationToken)
Asynchronously set the flags of the specified message.
Public methodSetFlagsAsync(IListUniqueId, MessageFlags, Boolean, CancellationToken)
Asynchronously set the flags of the specified messages.
Public methodSetFlagsAsync(IListInt32, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously set the flags of the specified messages.
Public methodSetFlagsAsync(IListInt32, UInt64, MessageFlags, Boolean, CancellationToken)
Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetFlagsAsync(Int32, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously set the flags of the specified message.
Public methodSetFlagsAsync(UniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously set the flags of the specified message.
Public methodSetFlagsAsync(IListUniqueId, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously set the flags of the specified messages.
Public methodSetFlagsAsync(IListUniqueId, UInt64, MessageFlags, Boolean, CancellationToken)
Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetFlagsAsync(IListInt32, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetFlagsAsync(IListUniqueId, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken)
Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetLabels(IListInt32, IListString, Boolean, CancellationToken)
Set the labels of the specified messages.
Public methodSetLabels(Int32, IListString, Boolean, CancellationToken)
Set the labels of the specified message.
Public methodSetLabels(UniqueId, IListString, Boolean, CancellationToken)
Set the labels of the specified message.
Public methodSetLabels(IListUniqueId, IListString, Boolean, CancellationToken)
Set the labels of the specified messages.
Public methodSetLabels(IListInt32, UInt64, IListString, Boolean, CancellationToken)
Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetLabels(IListUniqueId, UInt64, IListString, Boolean, CancellationToken)
Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetLabelsAsync(IListInt32, IListString, Boolean, CancellationToken)
Asynchronously set the labels of the specified messages.
Public methodSetLabelsAsync(Int32, IListString, Boolean, CancellationToken)
Asynchronously set the labels of the specified message.
Public methodSetLabelsAsync(UniqueId, IListString, Boolean, CancellationToken)
Asynchronously set the labels of the specified message.
Public methodSetLabelsAsync(IListUniqueId, IListString, Boolean, CancellationToken)
Asynchronously set the labels of the specified messages.
Public methodSetLabelsAsync(IListInt32, UInt64, IListString, Boolean, CancellationToken)
Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetLabelsAsync(IListUniqueId, UInt64, IListString, Boolean, CancellationToken)
Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
Public methodSetMetadata
Sets the specified metadata.
Public methodSetMetadataAsync
Asynchronously sets the specified metadata.
Public methodSetQuota
Set the quota limits for the folder.
Public methodSetQuotaAsync
Asynchronously set the quota limits for the folder.
Public methodSort(SearchQuery, IListOrderBy, CancellationToken)
Sort messages matching the specified query.
Public methodSort(SearchOptions, SearchQuery, IListOrderBy, CancellationToken)
Sort messages matching the specified query.
Public methodSort(IListUniqueId, SearchQuery, IListOrderBy, CancellationToken)
Sort messages matching the specified query.
Public methodSort(SearchOptions, IListUniqueId, SearchQuery, IListOrderBy, CancellationToken)
Sort messages matching the specified query.
Public methodSortAsync(SearchQuery, IListOrderBy, CancellationToken)
Asynchronously sort messages matching the specified query.
Public methodSortAsync(SearchOptions, SearchQuery, IListOrderBy, CancellationToken)
Asynchronously sort messages matching the specified query.
Public methodSortAsync(IListUniqueId, SearchQuery, IListOrderBy, CancellationToken)
Asynchronously sort messages matching the specified query.
Public methodSortAsync(SearchOptions, IListUniqueId, SearchQuery, IListOrderBy, CancellationToken)
Asynchronously sort messages matching the specified query.
Public methodStatus
Update the values of the specified items.
Public methodStatusAsync
Asynchronously update the values of the specified items.
Public methodStore(IListInt32, IListAnnotation, CancellationToken)
Store the annotations for the specified messages.
Public methodStore(Int32, IListAnnotation, CancellationToken)
Store the annotations for the specified message.
Public methodStore(UniqueId, IListAnnotation, CancellationToken)
Store the annotations for the specified message.
Public methodStore(IListUniqueId, IListAnnotation, CancellationToken)
Store the annotations for the specified messages.
Public methodStore(IListInt32, UInt64, IListAnnotation, CancellationToken)
Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
Public methodStore(IListUniqueId, UInt64, IListAnnotation, CancellationToken)
Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
Public methodStoreAsync(IListInt32, IListAnnotation, CancellationToken)
Asynchronously store the annotations for the specified messages.
Public methodStoreAsync(Int32, IListAnnotation, CancellationToken)
Asynchronously store the annotations for the specified message.
Public methodStoreAsync(UniqueId, IListAnnotation, CancellationToken)
Asynchronously store the annotations for the specified message.
Public methodStoreAsync(IListUniqueId, IListAnnotation, CancellationToken)
Asynchronously store the annotations for the specified messages.
Public methodStoreAsync(IListInt32, UInt64, IListAnnotation, CancellationToken)
Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
Public methodStoreAsync(IListUniqueId, UInt64, IListAnnotation, CancellationToken)
Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
Public methodSubscribe
Subscribe to the folder.
Public methodSubscribeAsync
Asynchronously subscribe to the folder.
Public methodSupports
Determine whether or not an IMailFolder supports a feature.
Public methodThread(ThreadingAlgorithm, SearchQuery, CancellationToken)
Thread the messages in the folder that match the search query using the specified threading algorithm.
Public methodThread(IListUniqueId, ThreadingAlgorithm, SearchQuery, CancellationToken)
Thread the messages in the folder that match the search query using the specified threading algorithm.
Public methodThreadAsync(ThreadingAlgorithm, SearchQuery, CancellationToken)
Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
Public methodThreadAsync(IListUniqueId, ThreadingAlgorithm, SearchQuery, CancellationToken)
Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
Public methodUnsubscribe
Unsubscribe from the folder.
Public methodUnsubscribeAsync
Asynchronously unsubscribe from the folder.
Top
Events
  NameDescription
Public eventAnnotationsChanged
Occurs when annotations changed on a message.
Public eventClosed
Occurs when the folder is closed.
Public eventCode exampleCountChanged
Occurs when the message count changes.
Public eventDeleted
Occurs when the folder is deleted.
Public eventHighestModSeqChanged
Occurs when the highest mod-sequence changes.
Public eventIdChanged
Occurs when the ID changes.
Public eventCode exampleMessageExpunged
Occurs when a message is expunged from the folder.
Public eventCode exampleMessageFlagsChanged
Occurs when flags changed on a message.
Public eventMessageLabelsChanged
Occurs when labels changed on a message.
Public eventMessageSummaryFetched
Occurs when a message summary is fetched from the folder.
Public eventMessagesVanished
Occurs when messages vanish from the folder.
Public eventMetadataChanged
Occurs when metadata changes.
Public eventModSeqChanged
Occurs when the mod-sequence changed on a message.
Public eventOpened
Occurs when the folder is opened.
Public eventRecentChanged
Occurs when the recent message count changes.
Public eventRenamed
Occurs when the folder is renamed.
Public eventSizeChanged
Occurs when the size of the folder changes.
Public eventSubscribed
Occurs when the folder is subscribed.
Public eventUidNextChanged
Occurs when the next UID changes.
Public eventUidValidityChanged
Occurs when the UID validity changes.
Public eventUnreadChanged
Occurs when the message unread count changes.
Public eventUnsubscribed
Occurs when the folder is unsubscribed.
Top
Remarks
Implemented by message stores such as ImapClient
See Also