C# Class MailKit.MailFolder

An abstract mail folder implementation.

Inheritance: IMailFolder

Show file Open project: jstedfast/MailKit

Protected Properties

Property	Type	Description
SettableFlags	MessageFlags

Public Methods

Method	Description
AddAccessRights ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add access rights for the specified identity. Adds the given access rights for the specified identity.
AddAccessRightsAsync ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add access rights for the specified identity. Asynchronously adds the given access rights for the specified identity.
AddFlags ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
AddFlags ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
AddFlags ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
AddFlags ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
AddFlags ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of flags to the specified messages. Adds a set of flags to the specified messages.
AddFlags ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of flags to the specified messages. Adds a set of flags to the specified messages.
AddFlags ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of flags to the specified messages. Adds a set of flags to the specified messages.
AddFlags ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of flags to the specified messages. Adds a set of flags to the specified messages.
AddFlags ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of flags to the specified message. Adds a set of flags to the specified message.
AddFlags ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of flags to the specified message. Adds a set of flags to the specified message.
AddFlags ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of flags to the specified message. Adds a set of flags to the specified message.
AddFlags ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of flags to the specified message. Adds a set of flags to the specified message.
AddFlagsAsync ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of flags to the specified messages. Asynchronously adds a set of flags to the specified messages.
AddFlagsAsync ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of flags to the specified messages. Asynchronously adds a set of flags to the specified messages.
AddFlagsAsync ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of flags to the specified messages. Asynchronously adds a set of flags to the specified messages.
AddFlagsAsync ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of flags to the specified messages. Asynchronously adds a set of flags to the specified messages.
AddFlagsAsync ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of flags to the specified message. Asynchronously adds a set of flags to the specified message.
AddFlagsAsync ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of flags to the specified message. Asynchronously adds a set of flags to the specified message.
AddFlagsAsync ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of flags to the specified message. Asynchronously adds a set of flags to the specified message.
AddFlagsAsync ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of flags to the specified message. Asynchronously adds a set of flags to the specified message.
AddFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
AddFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
AddFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
AddFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
AddLabels ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value. Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
AddLabels ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value. Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
AddLabels ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of labels to the specified messages. Adds a set of labels to the specified messages.
AddLabels ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of labels to the specified messages. Adds a set of labels to the specified messages.
AddLabels ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of labels to the specified message. Adds a set of labels to the specified message.
AddLabels ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Add a set of labels to the specified message. Adds a set of labels to the specified message.
AddLabelsAsync ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of labels to the specified messages. Asynchronously adds a set of labels to the specified messages.
AddLabelsAsync ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of labels to the specified messages. Asynchronously adds a set of labels to the specified messages.
AddLabelsAsync ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of labels to the specified message. Asynchronously adds a set of labels to the specified message.
AddLabelsAsync ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously add a set of labels to the specified message. Asynchronously adds a set of labels to the specified message.
AddLabelsAsync ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value. Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
AddLabelsAsync ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value. Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
Append ( MimeKit.FormatOptions options, IList messages, IList flags, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : IList	Append the specified messages to the folder. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
Append ( MimeKit.FormatOptions options, IList messages, IList flags, IList dates, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : IList	Append the specified messages to the folder. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
Append ( IList messages, IList flags, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : IList	Append the specified messages to the folder. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
Append ( IList messages, IList flags, IList dates, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : IList	Append the specified messages to the folder. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
Append ( MimeKit.FormatOptions options, MimeMessage message, MessageFlags flags = MessageFlags.None, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : UniqueId?	Append the specified message to the folder. Appends the specified message to the folder and returns the UniqueId assigned to the message.
Append ( MimeKit.FormatOptions options, MimeMessage message, MessageFlags flags, DateTimeOffset date, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : UniqueId?	Append the specified message to the folder. Appends the specified message to the folder and returns the UniqueId assigned to the message.
Append ( MimeMessage message, MessageFlags flags = MessageFlags.None, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : UniqueId?	Append the specified message to the folder. Appends the specified message to the folder and returns the UniqueId assigned to the message.
Append ( MimeMessage message, MessageFlags flags, DateTimeOffset date, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : UniqueId?	Append the specified message to the folder. Appends the specified message to the folder and returns the UniqueId assigned to the message.
AppendAsync ( MimeKit.FormatOptions options, IList messages, IList flags, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task>	Asynchronously append the specified messages to the folder. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
AppendAsync ( MimeKit.FormatOptions options, IList messages, IList flags, IList dates, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task>	Asynchronously append the specified messages to the folder. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
AppendAsync ( IList messages, IList flags, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task>	Asynchronously append the specified messages to the folder. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
AppendAsync ( IList messages, IList flags, IList dates, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task>	Asynchronously append the specified messages to the folder. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
AppendAsync ( MimeKit.FormatOptions options, MimeMessage message, MessageFlags flags = MessageFlags.None, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously append the specified message to the folder. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
AppendAsync ( MimeKit.FormatOptions options, MimeMessage message, MessageFlags flags, DateTimeOffset date, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously append the specified message to the folder. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
AppendAsync ( MimeMessage message, MessageFlags flags = MessageFlags.None, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously append the specified message to the folder. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
AppendAsync ( MimeMessage message, MessageFlags flags, DateTimeOffset date, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously append the specified message to the folder. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
Check ( CancellationToken cancellationToken = default(CancellationToken) ) : void	Force the server to flush its state for the folder. Forces the server to flush its state for the folder.
CheckAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously force the server to flush its state for the folder. Asynchronously forces the server to flush its state for the folder.
Close ( bool expunge = false, CancellationToken cancellationToken = default(CancellationToken) ) : void	Close the folder, optionally expunging the messages marked for deletion. Closes the folder, optionally expunging the messages marked for deletion.
CloseAsync ( bool expunge = false, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously close the folder, optionally expunging the messages marked for deletion. Asynchronously closes the folder, optionally expunging the messages marked for deletion.
CopyTo ( UniqueId uid, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : UniqueId?	Copy the specified message to the destination folder. Copies the specified message to the destination folder.
CopyTo ( IList uids, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : UniqueIdMap	Copy the specified messages to the destination folder. Copies the specified messages to the destination folder.
CopyTo ( IList indexes, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : void	Copy the specified messages to the destination folder. Copies the specified messages to the destination folder.
CopyTo ( int index, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : void	Copy the specified message to the destination folder. Copies the specified message to the destination folder.
CopyToAsync ( IList indexes, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously copy the specified messages to the destination folder. Asynchronously copies the specified messages to the destination folder.
CopyToAsync ( int index, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously copy the specified message to the destination folder. Asynchronously copies the specified message to the destination folder.
CopyToAsync ( UniqueId uid, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously copy the specified message to the destination folder. Asynchronously copies the specified message to the destination folder.
CopyToAsync ( IList uids, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously copy the specified messages to the destination folder. Asynchronously copies the specified messages to the destination folder.
Create ( string name, IEnumerable specialUses, CancellationToken cancellationToken = default(CancellationToken) ) : IMailFolder	Create a new subfolder with the given name. Creates a new subfolder with the given name.
Create ( string name, SpecialFolder specialUse, CancellationToken cancellationToken = default(CancellationToken) ) : IMailFolder	Create a new subfolder with the given name. Creates a new subfolder with the given name.
Create ( string name, bool isMessageFolder, CancellationToken cancellationToken = default(CancellationToken) ) : IMailFolder	Create a new subfolder with the given name. Creates a new subfolder with the given name.
CreateAsync ( string name, IEnumerable specialUses, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously create a new subfolder with the given name. Asynchronously creates a new subfolder with the given name.
CreateAsync ( string name, SpecialFolder specialUse, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously create a new subfolder with the given name. Asynchronously creates a new subfolder with the given name.
CreateAsync ( string name, bool isMessageFolder, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously create a new subfolder with the given name. Asynchronously creates a new subfolder with the given name.
Delete ( CancellationToken cancellationToken = default(CancellationToken) ) : void	Delete the folder. Deletes the folder.
DeleteAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously delete the folder. Asynchronously deletes the folder.
Expunge ( CancellationToken cancellationToken = default(CancellationToken) ) : void	Expunge the folder, permanently removing all messages marked for deletion. Expunges the folder, permanently removing all messages marked for deletion. Normally, an MessageExpunged event will be emitted for each message that is expunged. However, if the mail store supports the quick resynchronization feature and it has been enabled via the MailStore.EnableQuickResync(CancellationToken) method, then the MessagesVanished event will be emitted rather than the MessageExpunged event.
Expunge ( IList uids, CancellationToken cancellationToken = default(CancellationToken) ) : void	Expunge the specified uids, permanently removing them from the folder. Expunges the specified uids, permanently removing them from the folder. Normally, an MessageExpunged event will be emitted for each message that is expunged. However, if the mail store supports the quick resynchronization feature and it has been enabled via the MailStore.EnableQuickResync(CancellationToken) method, then the MessagesVanished event will be emitted rather than the MessageExpunged event.
ExpungeAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously expunge the folder, permanently removing all messages marked for deletion. Asynchronously expunges the folder, permanently removing all messages marked for deletion. Normally, an MessageExpunged event will be emitted for each message that is expunged. However, if the mail store supports the quick resynchronization feature and it has been enabled via the MailStore.EnableQuickResync(CancellationToken) method, then the MessagesVanished event will be emitted rather than the MessageExpunged event.
ExpungeAsync ( IList uids, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously expunge the specified uids, permanently removing them from the folder. Asynchronously expunges the specified uids, permanently removing them from the folder. Normally, an MessageExpunged event will be emitted for each message that is expunged. However, if the mail store supports the quick resynchronization feature and it has been enabled via the MailStore.EnableQuickResync(CancellationToken) method, then the MessagesVanished event will be emitted rather than the MessageExpunged event.
Fetch ( IList uids, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message UIDs. Fetches the message summaries for the specified message UIDs. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( IList uids, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message UIDs. Fetches the message summaries for the specified message UIDs. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( IList uids, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message UIDs. Fetches the message summaries for the specified message UIDs. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( IList uids, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. Fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. If the mail store supports quick resynchronization and the application has enabled this feature via MailStore.EnableQuickResync(CancellationToken), then this method will emit MessagesVanished events for messages that have vanished since the specified mod-sequence value. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( IList uids, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. Fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. If the mail store supports quick resynchronization and the application has enabled this feature via MailStore.EnableQuickResync(CancellationToken), then this method will emit MessagesVanished events for messages that have vanished since the specified mod-sequence value. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( IList uids, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. Fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. If the mail store supports quick resynchronization and the application has enabled this feature via MailStore.EnableQuickResync(CancellationToken), then this method will emit MessagesVanished events for messages that have vanished since the specified mod-sequence value. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( IList indexes, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message indexes. Fetches the message summaries for the specified message indexes. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( IList indexes, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message indexes. Fetches the message summaries for the specified message indexes. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( IList indexes, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message indexes. Fetches the message summaries for the specified message indexes. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( IList indexes, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. Fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( IList indexes, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. Fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( IList indexes, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. Fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( int min, int max, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the messages between the two indexes, inclusive. Fetches the message summaries for the messages between the two indexes, inclusive. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( int min, int max, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the messages between the two indexes, inclusive. Fetches the message summaries for the messages between the two indexes, inclusive. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( int min, int max, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the messages between the two indexes, inclusive. Fetches the message summaries for the messages between the two indexes, inclusive. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( int min, int max, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. Fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( int min, int max, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. Fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
Fetch ( int min, int max, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. Fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList uids, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message UIDs. Asynchronously fetches the message summaries for the specified message UIDs. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList uids, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message UIDs. Asynchronously fetches the message summaries for the specified message UIDs. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList uids, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message UIDs. Asynchronously fetches the message summaries for the specified message UIDs. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList uids, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. Asynchronously fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. If the mail store supports quick resynchronization and the application has enabled this feature via MailStore.EnableQuickResync(CancellationToken), then this method will emit MessagesVanished events for messages that have vanished since the specified mod-sequence value. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList uids, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. Asynchronously fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. If the mail store supports quick resynchronization and the application has enabled this feature via MailStore.EnableQuickResync(CancellationToken), then this method will emit MessagesVanished events for messages that have vanished since the specified mod-sequence value. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList uids, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. Asynchronously fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified. If the mail store supports quick resynchronization and the application has enabled this feature via MailStore.EnableQuickResync(CancellationToken), then this method will emit MessagesVanished events for messages that have vanished since the specified mod-sequence value. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList indexes, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message indexes. Asynchronously fetches the message summaries for the specified message indexes. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList indexes, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message indexes. Asynchronously fetches the message summaries for the specified message indexes. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList indexes, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message indexes. Asynchronously fetches the message summaries for the specified message indexes. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList indexes, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. Asynchronously fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList indexes, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. Asynchronously fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( IList indexes, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. Asynchronously fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( int min, int max, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the messages between the two indexes, inclusive. Asynchronously fetches the message summaries for the messages between the two indexes, inclusive. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( int min, int max, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the messages between the two indexes, inclusive. Asynchronously fetches the message summaries for the messages between the two indexes, inclusive. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( int min, int max, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the messages between the two indexes, inclusive. Asynchronously fetches the message summaries for the messages between the two indexes, inclusive. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( int min, int max, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. Asynchronously fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( int min, int max, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. Asynchronously fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
FetchAsync ( int min, int max, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. Asynchronously fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified. It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.
GetAccessControlList ( CancellationToken cancellationToken = default(CancellationToken) ) : AccessControlList	Get the complete access control list for the folder. Gets the complete access control list for the folder.
GetAccessControlListAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously get the complete access control list for the folder. Asynchronously gets the complete access control list for the folder.
GetAccessRights ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : AccessRights	Get the access rights for a particular identifier. Gets the access rights for a particular identifier.
GetAccessRightsAsync ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously get the access rights for a particular identifier. Asynchronously gets the access rights for a particular identifier.
GetBodyPart ( UniqueId uid, BodyPart part, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeKit.MimeEntity	Get the specified body part. Gets the specified body part.
GetBodyPart ( UniqueId uid, BodyPart part, bool headersOnly, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeKit.MimeEntity	Get the specified body part. Gets the specified body part.
GetBodyPart ( int index, BodyPart part, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeKit.MimeEntity	Get the specified body part. Gets the specified body part.
GetBodyPart ( int index, BodyPart part, bool headersOnly, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeKit.MimeEntity	Get the specified body part. Gets the specified body part.
GetBodyPartAsync ( UniqueId uid, BodyPart part, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get the specified body part. Asynchronously gets the specified body part.
GetBodyPartAsync ( UniqueId uid, BodyPart part, bool headersOnly, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get the specified body part. Asynchronously gets the specified body part.
GetBodyPartAsync ( int index, BodyPart part, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get the specified body part. Asynchronously gets the specified body part.
GetBodyPartAsync ( int index, BodyPart part, bool headersOnly, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get the specified body part. Asynchronously gets the specified body part.
GetEnumerator ( ) : IEnumerator	Get an enumerator for the messages in the folder. Gets an enumerator for the messages in the folder.
GetMessage ( UniqueId uid, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeMessage	Get the specified message. Gets the specified message.
GetMessage ( int index, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeMessage	Get the specified message. Gets the specified message.
GetMessageAsync ( UniqueId uid, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get the specified message. Asynchronously gets the specified message.
GetMessageAsync ( int index, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get the specified message. Asynchronously gets the specified message.
GetMetadata ( IEnumerable tags, CancellationToken cancellationToken = default(CancellationToken) ) : MetadataCollection	Gets the specified metadata. Gets the specified metadata.
GetMetadata ( MetadataOptions options, IEnumerable tags, CancellationToken cancellationToken = default(CancellationToken) ) : MetadataCollection	Gets the specified metadata. Gets the specified metadata.
GetMetadata ( MetadataTag tag, CancellationToken cancellationToken = default(CancellationToken) ) : string	Gets the specified metadata. Gets the specified metadata.
GetMetadataAsync ( IEnumerable tags, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously gets the specified metadata. Asynchronously gets the specified metadata.
GetMetadataAsync ( MetadataOptions options, IEnumerable tags, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously gets the specified metadata. Asynchronously gets the specified metadata.
GetMetadataAsync ( MetadataTag tag, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously gets the specified metadata. Asynchronously gets the specified metadata.
GetMyAccessRights ( CancellationToken cancellationToken = default(CancellationToken) ) : AccessRights	Get the access rights for the current authenticated user. Gets the access rights for the current authenticated user.
GetMyAccessRightsAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously get the access rights for the current authenticated user. Asynchronously gets the access rights for the current authenticated user.
GetQuota ( CancellationToken cancellationToken = default(CancellationToken) ) : FolderQuota	Get the quota information for the folder. Gets the quota information for the folder. To determine if a quotas are supported, check the IMailStore.SupportsQuotas property.
GetQuotaAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously get the quota information for the folder. Asynchronously gets the quota information for the folder. To determine if a quotas are supported, check the IMailStore.SupportsQuotas property.
GetStream ( UniqueId uid, BodyPart part, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream	Get a substream of the specified body part. Gets a substream of the body part. If the starting offset is beyond the end of the body part, an empty stream is returned. If the number of bytes desired extends beyond the end of the body part, a truncated stream will be returned.
GetStream ( UniqueId uid, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream	Get a substream of the specified message. Gets a substream of the message. If the starting offset is beyond the end of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the message, a truncated stream will be returned.
GetStream ( UniqueId uid, string section, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream	Get a substream of the specified message. Gets a substream of the specified message. For more information about how to construct the section, see Section 6.4.5 of RFC3501.
GetStream ( UniqueId uid, string section, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream	Get a substream of the specified message. Gets a substream of the specified message. If the starting offset is beyond the end of the specified section of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the section, a truncated stream will be returned. For more information about how to construct the section, see Section 6.4.5 of RFC3501.
GetStream ( int index, BodyPart part, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream	Get a substream of the specified body part. Gets a substream of the body part. If the starting offset is beyond the end of the body part, an empty stream is returned. If the number of bytes desired extends beyond the end of the body part, a truncated stream will be returned.
GetStream ( int index, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream	Get a substream of the specified message. Gets a substream of the message. If the starting offset is beyond the end of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the message, a truncated stream will be returned.
GetStream ( int index, string section, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream	Get a substream of the specified message. Gets a substream of the specified message. For more information about how to construct the section, see Section 6.4.5 of RFC3501.
GetStream ( int index, string section, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream	Get a substream of the specified message. Gets a substream of the specified message. If the starting offset is beyond the end of the specified section of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the section, a truncated stream will be returned. For more information about how to construct the section, see Section 6.4.5 of RFC3501.
GetStreamAsync ( UniqueId uid, BodyPart part, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get a substream of the specified body part. Asynchronously gets a substream of the body part. If the starting offset is beyond the end of the body part, an empty stream is returned. If the number of bytes desired extends beyond the end of the body part, a truncated stream will be returned.
GetStreamAsync ( UniqueId uid, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get a substream of the specified message. Asynchronously gets a substream of the message. If the starting offset is beyond the end of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the message, a truncated stream will be returned.
GetStreamAsync ( UniqueId uid, string section, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get a substream of the specified message. Asynchronously gets a substream of the specified message. For more information about how to construct the section, see Section 6.4.5 of RFC3501.
GetStreamAsync ( UniqueId uid, string section, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get a substream of the specified message. Asynchronously gets a substream of the specified message. If the starting offset is beyond the end of the specified section of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the section, a truncated stream will be returned. For more information about how to construct the section, see Section 6.4.5 of RFC3501.
GetStreamAsync ( int index, BodyPart part, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get a substream of the specified body part. Asynchronously gets a substream of the body part. If the starting offset is beyond the end of the body part, an empty stream is returned. If the number of bytes desired extends beyond the end of the body part, a truncated stream will be returned.
GetStreamAsync ( int index, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get a substream of the specified message. Asynchronously gets a substream of the message. If the starting offset is beyond the end of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the message, a truncated stream will be returned.
GetStreamAsync ( int index, string section, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get a substream of the specified body part. Asynchronously gets a substream of the specified message. For more information about how to construct the section, see Section 6.4.5 of RFC3501.
GetStreamAsync ( int index, string section, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task	Asynchronously get a substream of the specified body part. Asynchronously gets a substream of the specified message. If the starting offset is beyond the end of the specified section of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the section, a truncated stream will be returned. For more information about how to construct the section, see Section 6.4.5 of RFC3501.
GetSubfolder ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : IMailFolder	Get the specified subfolder. Gets the specified subfolder.
GetSubfolderAsync ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously get the specified subfolder. Asynchronously gets the specified subfolder.
GetSubfolders ( StatusItems items, bool subscribedOnly = false, CancellationToken cancellationToken = default(CancellationToken) ) : IEnumerable	Get the subfolders. Gets the subfolders as well as queries the server for the status of the requested items. When the items argument is non-empty, this has the equivalent functionality of calling GetSubfolders(bool,System.Threading.CancellationToken) and then calling Status(StatusItems,System.Threading.CancellationToken) on each of the returned folders.
GetSubfolders ( bool subscribedOnly = false, CancellationToken cancellationToken = default(CancellationToken) ) : IEnumerable	Get the subfolders. Gets the subfolders.
GetSubfoldersAsync ( StatusItems items, bool subscribedOnly = false, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously get the subfolders. Asynchronously gets the subfolders as well as queries the server for the status of the requested items. When the items argument is non-empty, this has the equivalent functionality of calling GetSubfoldersAsync(bool,System.Threading.CancellationToken) and then calling StatusAsync(StatusItems,System.Threading.CancellationToken) on each of the returned folders.
GetSubfoldersAsync ( bool subscribedOnly = false, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously get the subfolders. Asynchronously gets the subfolders.
MoveTo ( UniqueId uid, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : UniqueId?	Move the specified message to the destination folder. Moves the specified message to the destination folder.
MoveTo ( IList uids, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : UniqueIdMap	Move the specified messages to the destination folder. Moves the specified messages to the destination folder.
MoveTo ( IList indexes, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : void	Move the specified messages to the destination folder. Moves the specified messages to the destination folder.
MoveTo ( int index, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : void	Move the specified message to the destination folder. Moves the specified message to the destination folder.
MoveToAsync ( IList indexes, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously move the specified messages to the destination folder. Asynchronously moves the specified messages to the destination folder.
MoveToAsync ( int index, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously move the specified message to the destination folder. Asynchronously moves the specified message to the destination folder.
MoveToAsync ( UniqueId uid, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously move the specified message to the destination folder. Asynchronously moves the specified message to the destination folder.
MoveToAsync ( IList uids, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously move the specified messages to the destination folder. Asynchronously moves the specified messages to the destination folder.
Open ( FolderAccess access, CancellationToken cancellationToken = default(CancellationToken) ) : FolderAccess	Open the folder using the requested folder access. Opens the folder using the requested folder access.
Open ( FolderAccess access, uint uidValidity, ulong highestModSeq, IList uids, CancellationToken cancellationToken = default(CancellationToken) ) : FolderAccess	Opens the folder using the requested folder access. This variant of the Open(FolderAccess,System.Threading.CancellationToken) method is meant for quick resynchronization of the folder. Before calling this method, the MailStore.EnableQuickResync(CancellationToken) method MUST be called. You should also make sure to add listeners to the MessagesVanished and MessageFlagsChanged events to get notifications of changes since the last time the folder was opened.
OpenAsync ( FolderAccess access, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously open the folder using the requested folder access. Asynchronously opens the folder using the requested folder access.
OpenAsync ( FolderAccess access, uint uidValidity, ulong highestModSeq, IList uids, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously opens the folder using the requested folder access. This variant of the OpenAsync(FolderAccess,System.Threading.CancellationToken) method is meant for quick resynchronization of the folder. Before calling this method, the MailStore.EnableQuickResync(CancellationToken) method MUST be called. You should also make sure to add listeners to the MessagesVanished and MessageFlagsChanged events to get notifications of changes since the last time the folder was opened.
RemoveAccess ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove all access rights for the given identity. Removes all access rights for the given identity.
RemoveAccessAsync ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove all access rights for the given identity. Asynchronously removes all access rights for the given identity.
RemoveAccessRights ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove access rights for the specified identity. Removes the given access rights for the specified identity.
RemoveAccessRightsAsync ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove access rights for the specified identity. Asynchronously removes the given access rights for the specified identity.
RemoveFlags ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
RemoveFlags ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
RemoveFlags ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
RemoveFlags ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
RemoveFlags ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of flags from the specified messages. Removes a set of flags from the specified messages.
RemoveFlags ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of flags from the specified messages. Removes a set of flags from the specified messages.
RemoveFlags ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of flags from the specified messages. Removes a set of flags from the specified messages.
RemoveFlags ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of flags from the specified messages. Removes a set of flags from the specified messages.
RemoveFlags ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of flags from the specified message. Removes a set of flags from the specified message.
RemoveFlags ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of flags from the specified message. Removes a set of flags from the specified message.
RemoveFlags ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of flags from the specified message. Removes a set of flags from the specified message.
RemoveFlags ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of flags from the specified message. Removes a set of flags from the specified message.
RemoveFlagsAsync ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of flags from the specified messages. Asynchronously removes a set of flags from the specified messages.
RemoveFlagsAsync ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of flags from the specified messages. Asynchronously removes a set of flags from the specified messages.
RemoveFlagsAsync ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of flags from the specified messages. Asynchronously removes a set of flags from the specified messages.
RemoveFlagsAsync ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of flags from the specified messages. Asynchronously removes a set of flags from the specified messages.
RemoveFlagsAsync ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of flags from the specified message. Asynchronously removes a set of flags from the specified message.
RemoveFlagsAsync ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of flags from the specified message. Asynchronously removes a set of flags from the specified message.
RemoveFlagsAsync ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of flags from the specified message. Asynchronously removes a set of flags from the specified message.
RemoveFlagsAsync ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of flags from the specified message. Asynchronously removes a set of flags from the specified message.
RemoveFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
RemoveFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
RemoveFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
RemoveFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
RemoveLabels ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value. Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
RemoveLabels ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value. Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
RemoveLabels ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of labels from the specified messages. Removes a set of labels from the specified messages.
RemoveLabels ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of labels from the specified messages. Removes a set of labels from the specified messages.
RemoveLabels ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of labels from the specified message. Removes a set of labels from the specified message.
RemoveLabels ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Remove a set of labels from the specified message. Removes a set of labels from the specified message.
RemoveLabelsAsync ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of labels from the specified messages. Asynchronously removes a set of labels from the specified messages.
RemoveLabelsAsync ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of labels from the specified messages. Asynchronously removes a set of labels from the specified messages.
RemoveLabelsAsync ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of labels from the specified message. Asynchronously removes a set of labels from the specified message.
RemoveLabelsAsync ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously remove a set of labels from the specified message. Asynchronously removes a set of labels from the specified message.
RemoveLabelsAsync ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value. Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
RemoveLabelsAsync ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value. Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
Rename ( IMailFolder parent, string name, CancellationToken cancellationToken = default(CancellationToken) ) : void	Rename the folder. Renames the folder.
RenameAsync ( IMailFolder parent, string name, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously rename the folder. Asynchronously renames the folder.
Search ( IList uids, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Search the subset of UIDs in the folder for messages matching the specified query. The returned array of unique identifiers can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
Search ( SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Search the folder for messages matching the specified query. The returned array of unique identifiers can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
Search ( SearchOptions options, IList uids, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : SearchResults	Searches the subset of UIDs in the folder for messages matching the specified query. Searches the fsubset of UIDs in the folder for messages matching the specified query, returning only the specified search results.
Search ( SearchOptions options, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : SearchResults	Search the folder for messages matching the specified query. Searches the folder for messages matching the specified query, returning only the specified search results.
SearchAsync ( IList uids, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously search the subset of UIDs in the folder for messages matching the specified query. The returned array of unique identifiers can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
SearchAsync ( SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously search the folder for messages matching the specified query. The returned array of unique identifiers can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
SearchAsync ( SearchOptions options, IList uids, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously searches the subset of UIDs in the folder for messages matching the specified query. Asynchronously searches the fsubset of UIDs in the folder for messages matching the specified query, returning only the specified search results.
SearchAsync ( SearchOptions options, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously search the folder for messages matching the specified query. Asynchronously searches the folder for messages matching the specified query, returning only the specified search results.
SetAccessRights ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the access rights for the specified identity. Sets the access rights for the specified identity.
SetAccessRightsAsync ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the access rights for the specified identity. Asynchronously sets the access rights for the specified identity.
SetFlags ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Set the flags of the specified messages only if their mod-sequence value is less than the specified value. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
SetFlags ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Set the flags of the specified messages only if their mod-sequence value is less than the specified value. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
SetFlags ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Set the flags of the specified messages only if their mod-sequence value is less than the specified value. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
SetFlags ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Set the flags of the specified messages only if their mod-sequence value is less than the specified value. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
SetFlags ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the flags of the specified messages. Sets the flags of the specified messages.
SetFlags ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the flags of the specified messages. Sets the flags of the specified messages.
SetFlags ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the flags of the specified messages. Sets the flags of the specified messages.
SetFlags ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the flags of the specified messages. Sets the flags of the specified messages.
SetFlags ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the flags of the specified message. Sets the flags of the specified message.
SetFlags ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the flags of the specified message. Sets the flags of the specified message.
SetFlags ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the flags of the specified message. Sets the flags of the specified message.
SetFlags ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the flags of the specified message. Sets the flags of the specified message.
SetFlagsAsync ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the flags of the specified messages. Asynchronously sets the flags of the specified messages.
SetFlagsAsync ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the flags of the specified messages. Asynchronously sets the flags of the specified messages.
SetFlagsAsync ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the flags of the specified messages. Asynchronously sets the flags of the specified messages.
SetFlagsAsync ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the flags of the specified messages. Asynchronously sets the flags of the specified messages.
SetFlagsAsync ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the flags of the specified message. Asynchronously sets the flags of the specified message.
SetFlagsAsync ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the flags of the specified message. Asynchronously sets the flags of the specified message.
SetFlagsAsync ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the flags of the specified message. Asynchronously sets the flags of the specified message.
SetFlagsAsync ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the flags of the specified message. Asynchronously sets the flags of the specified message.
SetFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
SetFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
SetFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
SetFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
SetLabels ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Set the labels of the specified messages only if their mod-sequence value is less than the specified value. Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
SetLabels ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Set the labels of the specified messages only if their mod-sequence value is less than the specified value. Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
SetLabels ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the labels of the specified messages. Sets the labels of the specified messages.
SetLabels ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the labels of the specified messages. Sets the labels of the specified messages.
SetLabels ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the labels of the specified message. Sets the labels of the specified message.
SetLabels ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void	Set the labels of the specified message. Sets the labels of the specified message.
SetLabelsAsync ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the labels of the specified messages. Asynchronously sets the labels of the specified messages.
SetLabelsAsync ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the labels of the specified messages. Asynchronously sets the labels of the specified messages.
SetLabelsAsync ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the labels of the specified message. Asynchronously sets the labels of the specified message.
SetLabelsAsync ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the labels of the specified message. Asynchronously sets the labels of the specified message.
SetLabelsAsync ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value. Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
SetLabelsAsync ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value. Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
SetMetadata ( MetadataCollection metadata, CancellationToken cancellationToken = default(CancellationToken) ) : void	Sets the specified metadata. Sets the specified metadata.
SetMetadataAsync ( MetadataCollection metadata, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously sets the specified metadata. Asynchronously sets the specified metadata.
SetQuota ( uint messageLimit, uint storageLimit, CancellationToken cancellationToken = default(CancellationToken) ) : FolderQuota	Set the quota limits for the folder. Sets the quota limits for the folder. To determine if a quotas are supported, check the IMailStore.SupportsQuotas property.
SetQuotaAsync ( uint messageLimit, uint storageLimit, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously set the quota limits for the folder. Asynchronously sets the quota limits for the folder. To determine if a quotas are supported, check the IMailStore.SupportsQuotas property.
Sort ( IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Sort messages matching the specified query. The returned array of unique identifiers will be sorted in the preferred order and can be used with IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
Sort ( SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Sort messages matching the specified query. The returned array of unique identifiers will be sorted in the preferred order and can be used with IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
Sort ( SearchOptions options, IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : SearchResults	Sort messages matching the specified query. Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
Sort ( SearchOptions options, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : SearchResults	Sort messages matching the specified query. Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
SortAsync ( IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously sort messages matching the specified query. The returned array of unique identifiers will be sorted in the preferred order and can be used with IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
SortAsync ( SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously sort messages matching the specified query. The returned array of unique identifiers will be sorted in the preferred order and can be used with IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
SortAsync ( SearchOptions options, IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously sort messages matching the specified query, returning the search results in the specified sort order. Asynchronously searches the folder for messages matching the specified query, returning the search results in the specified sort order.
SortAsync ( SearchOptions options, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously sort messages matching the specified query. Asynchronously searches the folder for messages matching the specified query, returning the search results in the specified sort order.
Status ( StatusItems items, CancellationToken cancellationToken = default(CancellationToken) ) : void	Update the values of the specified items. Updates the values of the specified items. The Status(StatusItems, System.Threading.CancellationToken) method MUST NOT be used on a folder that is already in the opened state. Instead, other ways of getting the desired information should be used. For example, a common use for the Status(StatusItems,System.Threading.CancellationToken) method is to get the number of unread messages in the folder. When the folder is open, however, it is possible to use the MailFolder.Search(MailKit.Search.SearchQuery, System.Threading.CancellationToken) method to query for the list of unread messages.
StatusAsync ( StatusItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously update the values of the specified items. Updates the values of the specified items. The Status(StatusItems, System.Threading.CancellationToken) method MUST NOT be used on a folder that is already in the opened state. Instead, other ways of getting the desired information should be used. For example, a common use for the Status(StatusItems,System.Threading.CancellationToken) method is to get the number of unread messages in the folder. When the folder is open, however, it is possible to use the MailFolder.Search(MailKit.Search.SearchQuery, System.Threading.CancellationToken) method to query for the list of unread messages.
Subscribe ( CancellationToken cancellationToken = default(CancellationToken) ) : void	Subscribe to the folder. Subscribes to the folder.
SubscribeAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously subscribe to the folder. Asynchronously subscribes to the folder.
Thread ( IList uids, ThreadingAlgorithm algorithm, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Thread the messages in the folder that match the search query using the specified threading algorithm. The MessageThread.UniqueId can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
Thread ( ThreadingAlgorithm algorithm, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : IList	Thread the messages in the folder that match the search query using the specified threading algorithm. The MessageThread.UniqueId can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
ThreadAsync ( IList uids, ThreadingAlgorithm algorithm, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm. The MessageThread.UniqueId can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
ThreadAsync ( ThreadingAlgorithm algorithm, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm. The MessageThread.UniqueId can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).
ToString ( ) : string	Returns a System.String that represents the current MailKit.MailFolder. Returns a System.String that represents the current MailKit.MailFolder.
Unsubscribe ( CancellationToken cancellationToken = default(CancellationToken) ) : void	Unsubscribe from the folder. Unsubscribes from the folder.
UnsubscribeAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task	Asynchronously unsubscribe from the folder. Asynchronously unsubscribes from the folder.

Protected Methods

Method	Description
MailFolder ( ) : System	Initializes a new instance of the MailKit.MailFolder class. Initializes a new instance of the MailKit.MailFolder class.
OnClosed ( ) : void	Raise the closed event. Raises the closed event.
OnCountChanged ( ) : void	Raise the count changed event. Raises the count changed event.
OnDeleted ( ) : void	Raise the deleted event. Raises the deleted event.
OnHighestModSeqChanged ( ) : void	Raise the highest mod-sequence changed event. Raises the highest mod-sequence changed event.
OnMessageExpunged ( MessageEventArgs args ) : void	Raise the message expunged event. Raises the message expunged event.
OnMessageFlagsChanged ( MessageFlagsChangedEventArgs args ) : void	Raise the message flags changed event. Raises the message flags changed event.
OnMessageLabelsChanged ( MessageLabelsChangedEventArgs args ) : void	Raise the message labels changed event. Raises the message labels changed event.
OnMessageSummaryFetched ( IMessageSummary message ) : void	Raise the message summary fetched event. Raises the message summary fetched event. When multiple message summaries are being fetched from a remote folder, it is possible that the connection will drop or some other exception will occur, causing the Fetch method to fail, requiring the client to request the same set of message summaries again after it reconnects. This is obviously inefficient. To alleviate this potential problem, this event will be emitted as soon as the IMailFolder successfully retrieves the complete IMessageSummary for each requested message. The Fetch methods will return a list of all message summaries that any information was retrieved for, regardless of whether or not all of the requested items were fetched, therefore there may be a discrepency between the number of times this event is emitetd and the number of summary items returned from the Fetch method.
OnMessagesArrived ( MessagesArrivedEventArgs args ) : void	Raise the messages arrived event. Raises the messages arrived event.
OnMessagesVanished ( MessagesVanishedEventArgs args ) : void	Raise the messages vanished event. Raises the messages vanished event.
OnModSeqChanged ( ModSeqChangedEventArgs args ) : void	Raise the message mod-sequence changed event. Raises the message mod-sequence changed event.
OnOpened ( ) : void	Raise the opened event. Raises the opened event.
OnParentFolderRenamed ( ) : void	Notifies the folder that a parent folder has been renamed. IMailFolder implementations should override this method to update their state (such as updating their FullName property).
OnRecentChanged ( ) : void	Raise the recent changed event. Raises the recent changed event.
OnRenamed ( string oldName, string newName ) : void	Raise the renamed event. Raises the renamed event.
OnSubscribed ( ) : void	Raise the subscribed event. Raises the subscribed event.
OnUidValidityChanged ( ) : void	Raise the uid validity changed event. Raises the uid validity changed event.
OnUnsubscribed ( ) : void	Raise the unsubscribed event. Raises the unsubscribed event.

Private Methods

Method	Description
IEnumerable ( ) : IEnumerator	Get an enumerator for the messages in the folder. Gets an enumerator for the messages in the folder.
OnParentFolderRenamed ( object sender, FolderRenamedEventArgs e ) : void
Search ( IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : IList
Search ( SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : IList
Search ( SearchOptions options, IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : SearchResults
Search ( SearchOptions options, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : SearchResults
SearchAsync ( IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
SearchAsync ( SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
SearchAsync ( SearchOptions options, IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task
SearchAsync ( SearchOptions options, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task

Method Details

AddAccessRights() public abstract method

Add access rights for the specified identity.

Adds the given access rights for the specified identity.

/// is null. /// -or- /// is null. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The mail store does not support the ACL extension. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract AddAccessRights ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : void
name	string	The identity name.
rights	AccessRights	The access rights.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddAccessRightsAsync() public method

Asynchronously add access rights for the specified identity.

Asynchronously adds the given access rights for the specified identity.

public AddAccessRightsAsync ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : Task
name	string	The identity name.
rights	AccessRights	The access rights.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddFlags() public abstract method

Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

/// is null. /// /// One or more of the is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract AddFlags ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

AddFlags() public method

Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

public AddFlags ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

AddFlags() public abstract method

Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

public abstract AddFlags ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

AddFlags() public method

Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

public AddFlags ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

AddFlags() public abstract method

Add a set of flags to the specified messages.

Adds a set of flags to the specified messages.

/// is null. /// /// One or more of the is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The folder is not currently open in read-write mode. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract AddFlags ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddFlags() public method

Add a set of flags to the specified messages.

Adds a set of flags to the specified messages.

public AddFlags ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddFlags() public abstract method

Add a set of flags to the specified messages.

Adds a set of flags to the specified messages.

/// is null. /// /// One or more of the is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract AddFlags ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddFlags() public method

Add a set of flags to the specified messages.

Adds a set of flags to the specified messages.

/// is null. /// /// One or more of the is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public AddFlags ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddFlags() public method

Add a set of flags to the specified message.

Adds a set of flags to the specified message.

/// is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The folder is not currently open in read-write mode. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public AddFlags ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uid	UniqueId	The UID of the message.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddFlags() public method

Add a set of flags to the specified message.

Adds a set of flags to the specified message.

/// is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public AddFlags ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uid	UniqueId	The UID of the message.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddFlags() public method

Add a set of flags to the specified message.

Adds a set of flags to the specified message.

public AddFlags ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
index	int	The index of the message.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddFlags() public method

Add a set of flags to the specified message.

Adds a set of flags to the specified message.

public AddFlags ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
index	int	The index of the message.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified messages.

Asynchronously adds a set of flags to the specified messages.

public AddFlagsAsync ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified messages.

Asynchronously adds a set of flags to the specified messages.

public AddFlagsAsync ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified messages.

Asynchronously adds a set of flags to the specified messages.

/// is null. /// /// One or more of the is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public AddFlagsAsync ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified messages.

Asynchronously adds a set of flags to the specified messages.

/// is null. /// /// One or more of the is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public AddFlagsAsync ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified message.

Asynchronously adds a set of flags to the specified message.

public AddFlagsAsync ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uid	UniqueId	The UID of the message.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified message.

Asynchronously adds a set of flags to the specified message.

public AddFlagsAsync ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uid	UniqueId	The UID of the message.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified message.

Asynchronously adds a set of flags to the specified message.

public AddFlagsAsync ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
index	int	The index of the messages.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified message.

Asynchronously adds a set of flags to the specified message.

public AddFlagsAsync ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
index	int	The index of the messages.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

public AddFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

public AddFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

public AddFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to add.
userFlags	HashSet	A set of user-defined flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

AddFlagsAsync() public method

Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

public AddFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

AddLabels() public abstract method

Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.

Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// No labels were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract AddLabels ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

AddLabels() public abstract method

Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.

Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.

public abstract AddLabels ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

AddLabels() public abstract method

Add a set of labels to the specified messages.

Adds a set of labels to the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// No labels were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract AddLabels ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uids	IList	The UIDs of the messages.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddLabels() public abstract method

Add a set of labels to the specified messages.

Adds a set of labels to the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// No labels were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract AddLabels ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
indexes	IList	The indexes of the messages.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddLabels() public method

Add a set of labels to the specified message.

Adds a set of labels to the specified message.

/// is null. /// /// is invalid. /// -or- /// No labels were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public AddLabels ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uid	UniqueId	The UID of the message.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddLabels() public method

Add a set of labels to the specified message.

Adds a set of labels to the specified message.

public AddLabels ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
index	int	The index of the message.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

AddLabelsAsync() public method

Asynchronously add a set of labels to the specified messages.

Asynchronously adds a set of labels to the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// No labels were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public AddLabelsAsync ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The UIDs of the messages.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddLabelsAsync() public method

Asynchronously add a set of labels to the specified messages.

Asynchronously adds a set of labels to the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// No labels were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public AddLabelsAsync ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
indexes	IList	The indexes of the messages.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddLabelsAsync() public method

Asynchronously add a set of labels to the specified message.

Asynchronously adds a set of labels to the specified message.

public AddLabelsAsync ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uid	UniqueId	The UID of the message.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddLabelsAsync() public method

Asynchronously add a set of labels to the specified message.

Asynchronously adds a set of labels to the specified message.

public AddLabelsAsync ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
index	int	The index of the messages.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

AddLabelsAsync() public method

Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.

public AddLabelsAsync ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

AddLabelsAsync() public method

Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.

public AddLabelsAsync ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to add.
silent	bool	If set to true, no events will be emitted.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

Append() public abstract method

Append the specified messages to the folder.

Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.

/// is null. /// -or- /// is null. /// -or- /// is null. /// /// One or more of the is null. /// -or- /// The number of messages does not match the number of flags. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The does not exist. /// /// Internationalized formatting was requested but has not been enabled. /// /// The operation was canceled via the cancellation token. /// /// Internationalized formatting was requested but is not supported by the server. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Append ( MimeKit.FormatOptions options, IList messages, IList flags, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : IList
options	MimeKit.FormatOptions	The formatting options.
messages	IList	The array of messages to append to the folder.
flags	IList	The message flags to use for each message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	IList

Append() public abstract method

Append the specified messages to the folder.

Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.

/// is null. /// -or- /// is null. /// -or- /// is null. /// -or- /// is null. /// /// One or more of the is null. /// -or- /// The number of messages, flags, and dates do not match. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The does not exist. /// /// Internationalized formatting was requested but has not been enabled. /// /// The operation was canceled via the cancellation token. /// /// Internationalized formatting was requested but is not supported by the server. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Append ( MimeKit.FormatOptions options, IList messages, IList flags, IList dates, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : IList
options	MimeKit.FormatOptions	The formatting options.
messages	IList	The array of messages to append to the folder.
flags	IList	The message flags to use for each of the messages.
dates	IList	The received dates to use for each of the messages.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	IList

Append() public method

Append the specified messages to the folder.

Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.

/// is null. /// -or- /// is null. /// /// One or more of the is null. /// -or- /// The number of messages does not match the number of flags. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The does not exist. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public Append ( IList messages, IList flags, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : IList
messages	IList	The array of messages to append to the folder.
flags	IList	The message flags to use for each message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	IList

Append() public method

Append the specified messages to the folder.

Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.

/// is null. /// -or- /// is null. /// -or- /// is null. /// /// One or more of the is null. /// -or- /// The number of messages, flags, and dates do not match. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The does not exist. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public Append ( IList messages, IList flags, IList dates, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : IList
messages	IList	The array of messages to append to the folder.
flags	IList	The message flags to use for each of the messages.
dates	IList	The received dates to use for each of the messages.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	IList

Append() public abstract method

Append the specified message to the folder.

Appends the specified message to the folder and returns the UniqueId assigned to the message.

/// is null. /// -or- /// is null. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The does not exist. /// /// Internationalized formatting was requested but has not been enabled. /// /// The operation was canceled via the cancellation token. /// /// Internationalized formatting was requested but is not supported by the server. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Append ( MimeKit.FormatOptions options, MimeMessage message, MessageFlags flags = MessageFlags.None, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : UniqueId?
options	MimeKit.FormatOptions	The formatting options.
message	MimeKit.MimeMessage	The message.
flags	MessageFlags	The message flags.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	UniqueId?

Append() public abstract method

Append the specified message to the folder.

Appends the specified message to the folder and returns the UniqueId assigned to the message.

public abstract Append ( MimeKit.FormatOptions options, MimeMessage message, MessageFlags flags, DateTimeOffset date, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : UniqueId?
options	MimeKit.FormatOptions	The formatting options.
message	MimeKit.MimeMessage	The message.
flags	MessageFlags	The message flags.
date	DateTimeOffset	The received date of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	UniqueId?

Append() public method

Append the specified message to the folder.

Appends the specified message to the folder and returns the UniqueId assigned to the message.

/// is null. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The does not exist. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public Append ( MimeMessage message, MessageFlags flags = MessageFlags.None, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : UniqueId?
message	MimeKit.MimeMessage	The message.
flags	MessageFlags	The message flags.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	UniqueId?

Append() public method

Append the specified message to the folder.

Appends the specified message to the folder and returns the UniqueId assigned to the message.

public Append ( MimeMessage message, MessageFlags flags, DateTimeOffset date, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : UniqueId?
message	MimeKit.MimeMessage	The message.
flags	MessageFlags	The message flags.
date	DateTimeOffset	The received date of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	UniqueId?

AppendAsync() public method

Asynchronously append the specified messages to the folder.

Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.

public AppendAsync ( MimeKit.FormatOptions options, IList messages, IList flags, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task>
options	MimeKit.FormatOptions	The formatting options.
messages	IList	The array of messages to append to the folder.
flags	IList	The message flags to use for each message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task>

AppendAsync() public method

Asynchronously append the specified messages to the folder.

Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.

public AppendAsync ( MimeKit.FormatOptions options, IList messages, IList flags, IList dates, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task>
options	MimeKit.FormatOptions	The formatting options.
messages	IList	The array of messages to append to the folder.
flags	IList	The message flags to use for each of the messages.
dates	IList	The received dates to use for each of the messages.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task>

AppendAsync() public method

Asynchronously append the specified messages to the folder.

Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.

public AppendAsync ( IList messages, IList flags, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task>
messages	IList	The array of messages to append to the folder.
flags	IList	The message flags to use for each message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task>

AppendAsync() public method

Asynchronously append the specified messages to the folder.

Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.

public AppendAsync ( IList messages, IList flags, IList dates, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task>
messages	IList	The array of messages to append to the folder.
flags	IList	The message flags to use for each of the messages.
dates	IList	The received dates to use for each of the messages.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task>

AppendAsync() public method

Asynchronously append the specified message to the folder.

Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.

public AppendAsync ( MimeKit.FormatOptions options, MimeMessage message, MessageFlags flags = MessageFlags.None, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
options	MimeKit.FormatOptions	The formatting options.
message	MimeKit.MimeMessage	The message.
flags	MessageFlags	The message flags.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

AppendAsync() public method

Asynchronously append the specified message to the folder.

Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.

public AppendAsync ( MimeKit.FormatOptions options, MimeMessage message, MessageFlags flags, DateTimeOffset date, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
options	MimeKit.FormatOptions	The formatting options.
message	MimeKit.MimeMessage	The message.
flags	MessageFlags	The message flags.
date	DateTimeOffset	The received date of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

AppendAsync() public method

Asynchronously append the specified message to the folder.

Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.

public AppendAsync ( MimeMessage message, MessageFlags flags = MessageFlags.None, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
message	MimeKit.MimeMessage	The message.
flags	MessageFlags	The message flags.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

AppendAsync() public method

Asynchronously append the specified message to the folder.

Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.

public AppendAsync ( MimeMessage message, MessageFlags flags, DateTimeOffset date, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
message	MimeKit.MimeMessage	The message.
flags	MessageFlags	The message flags.
date	DateTimeOffset	The received date of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

Check() public abstract method

Force the server to flush its state for the folder.

Forces the server to flush its state for the folder.

/// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Check ( CancellationToken cancellationToken = default(CancellationToken) ) : void
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

CheckAsync() public method

Asynchronously force the server to flush its state for the folder.

Asynchronously forces the server to flush its state for the folder.

public CheckAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

Close() public abstract method

Close the folder, optionally expunging the messages marked for deletion.

Closes the folder, optionally expunging the messages marked for deletion.

public abstract Close ( bool expunge = false, CancellationToken cancellationToken = default(CancellationToken) ) : void
expunge	bool	If set to true, expunge.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

CloseAsync() public method

Asynchronously close the folder, optionally expunging the messages marked for deletion.

Asynchronously closes the folder, optionally expunging the messages marked for deletion.

public CloseAsync ( bool expunge = false, CancellationToken cancellationToken = default(CancellationToken) ) : Task
expunge	bool	If set to true, expunge.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

CopyTo() public method

Copy the specified message to the destination folder.

Copies the specified message to the destination folder.

/// is null. /// /// is invalid. /// -or- /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The mail store does not support the UIDPLUS extension. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public CopyTo ( UniqueId uid, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : UniqueId?
uid	UniqueId	The UID of the message to copy.
destination	IMailFolder	The destination folder.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	UniqueId?

CopyTo() public abstract method

Copy the specified messages to the destination folder.

Copies the specified messages to the destination folder.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The mail store does not support the UIDPLUS extension. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract CopyTo ( IList uids, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : UniqueIdMap
uids	IList	The UIDs of the messages to copy.
destination	IMailFolder	The destination folder.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	UniqueIdMap

CopyTo() public abstract method

Copy the specified messages to the destination folder.

Copies the specified messages to the destination folder.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract CopyTo ( IList indexes, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : void
indexes	IList	The indexes of the messages to copy.
destination	IMailFolder	The destination folder.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

CopyTo() public method

Copy the specified message to the destination folder.

Copies the specified message to the destination folder.

/// is null. /// /// does not refer to a valid message index. /// /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public CopyTo ( int index, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : void
index	int	The index of the message to copy.
destination	IMailFolder	The destination folder.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

CopyToAsync() public method

Asynchronously copy the specified messages to the destination folder.

Asynchronously copies the specified messages to the destination folder.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public CopyToAsync ( IList indexes, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task
indexes	IList	The indexes of the messages to copy.
destination	IMailFolder	The destination folder.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

CopyToAsync() public method

Asynchronously copy the specified message to the destination folder.

Asynchronously copies the specified message to the destination folder.

public CopyToAsync ( int index, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task
index	int	The indexes of the message to copy.
destination	IMailFolder	The destination folder.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

CopyToAsync() public method

Asynchronously copy the specified message to the destination folder.

Asynchronously copies the specified message to the destination folder.

public CopyToAsync ( UniqueId uid, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uid	UniqueId	The UID of the message to copy.
destination	IMailFolder	The destination folder.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

CopyToAsync() public method

Asynchronously copy the specified messages to the destination folder.

Asynchronously copies the specified messages to the destination folder.

public CopyToAsync ( IList uids, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The UIDs of the messages to copy.
destination	IMailFolder	The destination folder.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

Create() public abstract method

Create a new subfolder with the given name.

Creates a new subfolder with the given name.

/// is null. /// -or- /// is null. /// /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The is nil, and thus child folders cannot be created. /// /// The does not support the creation of special folders. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Create ( string name, IEnumerable specialUses, CancellationToken cancellationToken = default(CancellationToken) ) : IMailFolder
name	string	The name of the folder to create.
specialUses	IEnumerable	A list of special uses for the folder being created.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IMailFolder

Create() public method

Create a new subfolder with the given name.

Creates a new subfolder with the given name.

/// is null. /// /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The is nil, and thus child folders cannot be created. /// /// The does not support the creation of special folders. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public Create ( string name, SpecialFolder specialUse, CancellationToken cancellationToken = default(CancellationToken) ) : IMailFolder
name	string	The name of the folder to create.
specialUse	SpecialFolder	The special use for the folder being created.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IMailFolder

Create() public abstract method

Create a new subfolder with the given name.

Creates a new subfolder with the given name.

/// is null. /// /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The is nil, and thus child folders cannot be created. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Create ( string name, bool isMessageFolder, CancellationToken cancellationToken = default(CancellationToken) ) : IMailFolder
name	string	The name of the folder to create.
isMessageFolder	bool	true if the folder will be used to contain messages; otherwise false.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IMailFolder

CreateAsync() public method

Asynchronously create a new subfolder with the given name.

Asynchronously creates a new subfolder with the given name.

public CreateAsync ( string name, IEnumerable specialUses, CancellationToken cancellationToken = default(CancellationToken) ) : Task
name	string	The name of the folder to create.
specialUses	IEnumerable	A list of special uses for the folder being created.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

CreateAsync() public method

Asynchronously create a new subfolder with the given name.

Asynchronously creates a new subfolder with the given name.

public CreateAsync ( string name, SpecialFolder specialUse, CancellationToken cancellationToken = default(CancellationToken) ) : Task
name	string	The name of the folder to create.
specialUse	SpecialFolder	The special use for the folder being created.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

CreateAsync() public method

Asynchronously create a new subfolder with the given name.

Asynchronously creates a new subfolder with the given name.

/// is null. /// /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The is nil, and thus child folders cannot be created. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public CreateAsync ( string name, bool isMessageFolder, CancellationToken cancellationToken = default(CancellationToken) ) : Task
name	string	The name of the folder to create.
isMessageFolder	bool	true if the folder will be used to contain messages; otherwise false.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

Delete() public abstract method

Delete the folder.

Deletes the folder.

/// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder cannot be deleted (it is either a namespace or the Inbox). /// /// The does not exist. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Delete ( CancellationToken cancellationToken = default(CancellationToken) ) : void
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

DeleteAsync() public method

Asynchronously delete the folder.

Asynchronously deletes the folder.

public DeleteAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

Expunge() public abstract method

Expunge the folder, permanently removing all messages marked for deletion.

Expunges the folder, permanently removing all messages marked for deletion.

Normally, an MessageExpunged event will be emitted for each message that is expunged. However, if the mail store supports the quick resynchronization feature and it has been enabled via the MailStore.EnableQuickResync(CancellationToken) method, then the MessagesVanished event will be emitted rather than the MessageExpunged event.

/// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Expunge ( CancellationToken cancellationToken = default(CancellationToken) ) : void
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

Expunge() public abstract method

Expunge the specified uids, permanently removing them from the folder.

Expunges the specified uids, permanently removing them from the folder.

/// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Expunge ( IList uids, CancellationToken cancellationToken = default(CancellationToken) ) : void
uids	IList	The message uids.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	void

ExpungeAsync() public method

Asynchronously expunge the folder, permanently removing all messages marked for deletion.

Asynchronously expunges the folder, permanently removing all messages marked for deletion.

public ExpungeAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

ExpungeAsync() public method

Asynchronously expunge the specified uids, permanently removing them from the folder.

Asynchronously expunges the specified uids, permanently removing them from the folder.

public ExpungeAsync ( IList uids, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The message uids.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

Fetch() public abstract method

Fetch the message summaries for the specified message UIDs.

Fetches the message summaries for the specified message UIDs.

It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.

/// is null. /// /// is empty. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Fetch ( IList uids, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the specified message UIDs.

Fetches the message summaries for the specified message UIDs.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Fetch ( IList uids, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the specified message UIDs.

Fetches the message summaries for the specified message UIDs.

public abstract Fetch ( IList uids, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

Fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

If the mail store supports quick resynchronization and the application has enabled this feature via MailStore.EnableQuickResync(CancellationToken), then this method will emit MessagesVanished events for messages that have vanished since the specified mod-sequence value.

/// is null. /// /// is empty. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Fetch ( IList uids, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

Fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Fetch ( IList uids, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

Fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Fetch ( IList uids, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the specified message indexes.

Fetches the message summaries for the specified message indexes.

public abstract Fetch ( IList indexes, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the specified message indexes.

Fetches the message summaries for the specified message indexes.

public abstract Fetch ( IList indexes, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the specified message indexes.

Fetches the message summaries for the specified message indexes.

public abstract Fetch ( IList indexes, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

Fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

/// is null. /// /// is empty. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Fetch ( IList indexes, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

Fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

public abstract Fetch ( IList indexes, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

Fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

public abstract Fetch ( IList indexes, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the messages between the two indexes, inclusive.

Fetches the message summaries for the messages between the two indexes, inclusive.

/// is out of range. /// -or- /// is out of range. /// -or- /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Fetch ( int min, int max, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the messages between the two indexes, inclusive.

Fetches the message summaries for the messages between the two indexes, inclusive.

/// is out of range. /// -or- /// is out of range. /// /// is null. /// /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Fetch ( int min, int max, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the messages between the two indexes, inclusive.

Fetches the message summaries for the messages between the two indexes, inclusive.

public abstract Fetch ( int min, int max, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

Fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

/// is out of range. /// -or- /// is out of range. /// -or- /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Fetch ( int min, int max, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : IList
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

Fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

/// is out of range. /// -or- /// is out of range. /// /// is null. /// /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Fetch ( int min, int max, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

Fetch() public abstract method

Fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

Fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

/// is out of range. /// -or- /// is out of range. /// /// is null. /// /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Fetch ( int min, int max, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : IList
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IList

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message UIDs.

Asynchronously fetches the message summaries for the specified message UIDs.

public FetchAsync ( IList uids, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message UIDs.

Asynchronously fetches the message summaries for the specified message UIDs.

public FetchAsync ( IList uids, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message UIDs.

Asynchronously fetches the message summaries for the specified message UIDs.

public FetchAsync ( IList uids, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

Asynchronously fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

/// is null. /// /// is empty. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public FetchAsync ( IList uids, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

Asynchronously fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public FetchAsync ( IList uids, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

Asynchronously fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public FetchAsync ( IList uids, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message indexes.

Asynchronously fetches the message summaries for the specified message indexes.

public FetchAsync ( IList indexes, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message indexes.

Asynchronously fetches the message summaries for the specified message indexes.

public FetchAsync ( IList indexes, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message indexes.

Asynchronously fetches the message summaries for the specified message indexes.

public FetchAsync ( IList indexes, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

Asynchronously fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

/// is null. /// /// is empty. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public FetchAsync ( IList indexes, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

Asynchronously fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

public FetchAsync ( IList indexes, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

Asynchronously fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.

public FetchAsync ( IList indexes, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.

Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.

public FetchAsync ( int min, int max, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.

Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.

public FetchAsync ( int min, int max, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.

Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.

public FetchAsync ( int min, int max, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

Asynchronously fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

/// is out of range. /// -or- /// is out of range. /// -or- /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public FetchAsync ( int min, int max, ulong modseq, MessageSummaryItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

Asynchronously fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

/// is out of range. /// -or- /// is out of range. /// /// is null. /// /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public FetchAsync ( int min, int max, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

FetchAsync() public method

Asynchronously fetch the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

Asynchronously fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.

/// is out of range. /// -or- /// is out of range. /// /// is null. /// /// is empty. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public FetchAsync ( int min, int max, ulong modseq, MessageSummaryItems items, HashSet fields, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
min	int	The minimum index.
max	int	The maximum index, or -1 to specify no upper bound.
modseq	ulong	The mod-sequence value.
items	MessageSummaryItems	The message summary items to fetch.
fields	HashSet	The desired header fields.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

GetAccessControlList() public abstract method

Get the complete access control list for the folder.

Gets the complete access control list for the folder.

/// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The mail store does not support the ACL extension. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetAccessControlList ( CancellationToken cancellationToken = default(CancellationToken) ) : AccessControlList
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	AccessControlList

GetAccessControlListAsync() public method

Asynchronously get the complete access control list for the folder.

Asynchronously gets the complete access control list for the folder.

public GetAccessControlListAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

GetAccessRights() public abstract method

Get the access rights for a particular identifier.

Gets the access rights for a particular identifier.

/// is null. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The mail store does not support the ACL extension. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetAccessRights ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : AccessRights
name	string	The identifier name.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	AccessRights

GetAccessRightsAsync() public method

Asynchronously get the access rights for a particular identifier.

Asynchronously gets the access rights for a particular identifier.

public GetAccessRightsAsync ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : Task
name	string	The identifier name.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

GetBodyPart() public abstract method

Get the specified body part.

Gets the specified body part.

/// is null. /// /// is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The did not return the requested message body. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetBodyPart ( UniqueId uid, BodyPart part, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeKit.MimeEntity
uid	UniqueId	The UID of the message.
part	BodyPart	The body part.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	MimeKit.MimeEntity

GetBodyPart() public abstract method

Get the specified body part.

Gets the specified body part.

public abstract GetBodyPart ( UniqueId uid, BodyPart part, bool headersOnly, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeKit.MimeEntity
uid	UniqueId	The UID of the message.
part	BodyPart	The body part.
headersOnly	bool	true if only the headers should be downloaded; otherwise, false>
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	MimeKit.MimeEntity

GetBodyPart() public abstract method

Get the specified body part.

Gets the specified body part.

/// is null. /// /// is out of range. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The did not return the requested message body. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetBodyPart ( int index, BodyPart part, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeKit.MimeEntity
index	int	The index of the message.
part	BodyPart	The body part.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	MimeKit.MimeEntity

GetBodyPart() public abstract method

Get the specified body part.

Gets the specified body part.

public abstract GetBodyPart ( int index, BodyPart part, bool headersOnly, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeKit.MimeEntity
index	int	The index of the message.
part	BodyPart	The body part.
headersOnly	bool	true if only the headers should be downloaded; otherwise, false>
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	MimeKit.MimeEntity

GetBodyPartAsync() public method

Asynchronously get the specified body part.

Asynchronously gets the specified body part.

public GetBodyPartAsync ( UniqueId uid, BodyPart part, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
uid	UniqueId	The UID of the message.
part	BodyPart	The body part.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetBodyPartAsync() public method

Asynchronously get the specified body part.

Asynchronously gets the specified body part.

public GetBodyPartAsync ( UniqueId uid, BodyPart part, bool headersOnly, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
uid	UniqueId	The UID of the message.
part	BodyPart	The body part.
headersOnly	bool	true if only the headers should be downloaded; otherwise, false>
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetBodyPartAsync() public method

Asynchronously get the specified body part.

Asynchronously gets the specified body part.

public GetBodyPartAsync ( int index, BodyPart part, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
index	int	The index of the message.
part	BodyPart	The body part.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetBodyPartAsync() public method

Asynchronously get the specified body part.

Asynchronously gets the specified body part.

public GetBodyPartAsync ( int index, BodyPart part, bool headersOnly, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
index	int	The index of the message.
part	BodyPart	The body part.
headersOnly	bool	true if only the headers should be downloaded; otherwise, false>
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetEnumerator() public abstract method

Get an enumerator for the messages in the folder.

Gets an enumerator for the messages in the folder.

/// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. ///

public abstract GetEnumerator ( ) : IEnumerator
return	IEnumerator

GetMessage() public abstract method

Get the specified message.

Gets the specified message.

/// is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The did not return the requested message. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetMessage ( UniqueId uid, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeMessage
uid	UniqueId	The UID of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	MimeKit.MimeMessage

GetMessage() public abstract method

Get the specified message.

Gets the specified message.

/// is out of range. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The did not return the requested message. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetMessage ( int index, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : MimeMessage
index	int	The index of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	MimeKit.MimeMessage

GetMessageAsync() public method

Asynchronously get the specified message.

Asynchronously gets the specified message.

public GetMessageAsync ( UniqueId uid, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
uid	UniqueId	The UID of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetMessageAsync() public method

Asynchronously get the specified message.

Asynchronously gets the specified message.

public GetMessageAsync ( int index, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
index	int	The index of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetMetadata() public method

Gets the specified metadata.

/// is null. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder does not support metadata. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public GetMetadata ( IEnumerable tags, CancellationToken cancellationToken = default(CancellationToken) ) : MetadataCollection
tags	IEnumerable	The metadata tags.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	MetadataCollection

GetMetadata() public abstract method

Gets the specified metadata.

/// is null. /// -or- /// is null. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder does not support metadata. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetMetadata ( MetadataOptions options, IEnumerable tags, CancellationToken cancellationToken = default(CancellationToken) ) : MetadataCollection
options	MetadataOptions	The metadata options.
tags	IEnumerable	The metadata tags.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	MetadataCollection

GetMetadata() public abstract method

Gets the specified metadata.

/// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder does not support metadata. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetMetadata ( MetadataTag tag, CancellationToken cancellationToken = default(CancellationToken) ) : string
tag	MetadataTag	The metadata tag.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	string

GetMetadataAsync() public method

Asynchronously gets the specified metadata.

public GetMetadataAsync ( IEnumerable tags, CancellationToken cancellationToken = default(CancellationToken) ) : Task
tags	IEnumerable	The metadata tags.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

GetMetadataAsync() public method

Asynchronously gets the specified metadata.

public GetMetadataAsync ( MetadataOptions options, IEnumerable tags, CancellationToken cancellationToken = default(CancellationToken) ) : Task
options	MetadataOptions	The metadata options.
tags	IEnumerable	The metadata tags.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

GetMetadataAsync() public method

Asynchronously gets the specified metadata.

public GetMetadataAsync ( MetadataTag tag, CancellationToken cancellationToken = default(CancellationToken) ) : Task
tag	MetadataTag	The metadata tag.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

GetMyAccessRights() public abstract method

Get the access rights for the current authenticated user.

Gets the access rights for the current authenticated user.

public abstract GetMyAccessRights ( CancellationToken cancellationToken = default(CancellationToken) ) : AccessRights
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	AccessRights

GetMyAccessRightsAsync() public method

Asynchronously get the access rights for the current authenticated user.

Asynchronously gets the access rights for the current authenticated user.

public GetMyAccessRightsAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

GetQuota() public abstract method

Get the quota information for the folder.

Gets the quota information for the folder.

To determine if a quotas are supported, check the IMailStore.SupportsQuotas property.

/// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The mail store does not support quotas. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetQuota ( CancellationToken cancellationToken = default(CancellationToken) ) : FolderQuota
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	FolderQuota

GetQuotaAsync() public method

Asynchronously get the quota information for the folder.

Asynchronously gets the quota information for the folder.

To determine if a quotas are supported, check the IMailStore.SupportsQuotas property.

public GetQuotaAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

GetStream() public method

Get a substream of the specified body part.

Gets a substream of the body part. If the starting offset is beyond the end of the body part, an empty stream is returned. If the number of bytes desired extends beyond the end of the body part, a truncated stream will be returned.

/// is invalid. /// /// is null. /// /// is negative. /// -or- /// is negative. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The did not return the requested message stream. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public GetStream ( UniqueId uid, BodyPart part, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream
uid	UniqueId	The UID of the message.
part	BodyPart	The desired body part.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Stream

GetStream() public abstract method

Get a substream of the specified message.

Gets a substream of the message. If the starting offset is beyond the end of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the message, a truncated stream will be returned.

/// is invalid. /// /// is negative. /// -or- /// is negative. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The did not return the requested message stream. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetStream ( UniqueId uid, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream
uid	UniqueId	The UID of the message.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Stream

GetStream() public abstract method

Get a substream of the specified message.

Gets a substream of the specified message.

For more information about how to construct the section, see Section 6.4.5 of RFC3501.

/// is invalid. /// /// is null. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The did not return the requested message stream. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetStream ( UniqueId uid, string section, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream
uid	UniqueId	The UID of the message.
section	string	The desired section of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Stream

GetStream() public abstract method

Get a substream of the specified message.

Gets a substream of the specified message. If the starting offset is beyond the end of the specified section of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the section, a truncated stream will be returned.

For more information about how to construct the section, see Section 6.4.5 of RFC3501.

public abstract GetStream ( UniqueId uid, string section, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream
uid	UniqueId	The UID of the message.
section	string	The desired section of the message.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Stream

GetStream() public method

Get a substream of the specified body part.

/// is null. /// /// is out of range. /// -or- /// is negative. /// -or- /// is negative. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The did not return the requested message stream. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public GetStream ( int index, BodyPart part, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream
index	int	The index of the message.
part	BodyPart	The desired body part.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Stream

GetStream() public abstract method

Get a substream of the specified message.

/// is out of range. /// -or- /// is negative. /// -or- /// is negative. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The did not return the requested message stream. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetStream ( int index, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream
index	int	The index of the message.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Stream

GetStream() public abstract method

Get a substream of the specified message.

Gets a substream of the specified message.

For more information about how to construct the section, see Section 6.4.5 of RFC3501.

/// is null. /// /// is out of range. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The did not return the requested message stream. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetStream ( int index, string section, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream
index	int	The index of the message.
section	string	The desired section of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Stream

GetStream() public abstract method

Get a substream of the specified message.

For more information about how to construct the section, see Section 6.4.5 of RFC3501.

public abstract GetStream ( int index, string section, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Stream
index	int	The index of the message.
section	string	The desired section of the message.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Stream

GetStreamAsync() public method

Asynchronously get a substream of the specified body part.

Asynchronously gets a substream of the body part. If the starting offset is beyond the end of the body part, an empty stream is returned. If the number of bytes desired extends beyond the end of the body part, a truncated stream will be returned.

public GetStreamAsync ( UniqueId uid, BodyPart part, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
uid	UniqueId	The UID of the message.
part	BodyPart	The desired body part.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetStreamAsync() public method

Asynchronously get a substream of the specified message.

Asynchronously gets a substream of the message. If the starting offset is beyond the end of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the message, a truncated stream will be returned.

public GetStreamAsync ( UniqueId uid, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
uid	UniqueId	The UID of the message.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetStreamAsync() public method

Asynchronously get a substream of the specified message.

Asynchronously gets a substream of the specified message.

For more information about how to construct the section, see Section 6.4.5 of RFC3501.

public GetStreamAsync ( UniqueId uid, string section, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
uid	UniqueId	The UID of the message.
section	string	The desired section of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetStreamAsync() public method

Asynchronously get a substream of the specified message.

Asynchronously gets a substream of the specified message. If the starting offset is beyond the end of the specified section of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the section, a truncated stream will be returned.

For more information about how to construct the section, see Section 6.4.5 of RFC3501.

public GetStreamAsync ( UniqueId uid, string section, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
uid	UniqueId	The UID of the message.
section	string	The desired section of the message.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetStreamAsync() public method

Asynchronously get a substream of the specified body part.

public GetStreamAsync ( int index, BodyPart part, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
index	int	The index of the message.
part	BodyPart	The desired body part.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetStreamAsync() public method

Asynchronously get a substream of the specified message.

public GetStreamAsync ( int index, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
index	int	The index of the message.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetStreamAsync() public method

Asynchronously get a substream of the specified body part.

Asynchronously gets a substream of the specified message.

For more information about how to construct the section, see Section 6.4.5 of RFC3501.

/// is null. /// /// is out of range. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The did not return the requested message stream. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public GetStreamAsync ( int index, string section, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
index	int	The index of the message.
section	string	The desired section of the message.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetStreamAsync() public method

Asynchronously get a substream of the specified body part.

For more information about how to construct the section, see Section 6.4.5 of RFC3501.

public GetStreamAsync ( int index, string section, int offset, int count, CancellationToken cancellationToken = default(CancellationToken), ITransferProgress progress = null ) : Task
index	int	The index of the message.
section	string	The desired section of the message.
offset	int	The starting offset of the first desired byte.
count	int	The number of bytes desired.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
progress	ITransferProgress	The progress reporting mechanism.
return	Task

GetSubfolder() public abstract method

Get the specified subfolder.

Gets the specified subfolder.

/// is null. /// /// is either an empty string or contains the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The requested folder could not be found. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetSubfolder ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : IMailFolder
name	string	The name of the subfolder.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IMailFolder

GetSubfolderAsync() public method

Asynchronously get the specified subfolder.

Asynchronously gets the specified subfolder.

public GetSubfolderAsync ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : Task
name	string	The name of the subfolder.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task

GetSubfolders() public abstract method

Get the subfolders.

Gets the subfolders as well as queries the server for the status of the requested items.

When the items argument is non-empty, this has the equivalent functionality of calling GetSubfolders(bool,System.Threading.CancellationToken) and then calling Status(StatusItems,System.Threading.CancellationToken) on each of the returned folders.

/// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract GetSubfolders ( StatusItems items, bool subscribedOnly = false, CancellationToken cancellationToken = default(CancellationToken) ) : IEnumerable
items	StatusItems	The status items to pre-populate.
subscribedOnly	bool	If set to true, only subscribed folders will be listed.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IEnumerable

GetSubfolders() public method

Get the subfolders.

Gets the subfolders.

public GetSubfolders ( bool subscribedOnly = false, CancellationToken cancellationToken = default(CancellationToken) ) : IEnumerable
subscribedOnly	bool	If set to true, only subscribed folders will be listed.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	IEnumerable

GetSubfoldersAsync() public method

Asynchronously get the subfolders.

Asynchronously gets the subfolders as well as queries the server for the status of the requested items.

When the items argument is non-empty, this has the equivalent functionality of calling GetSubfoldersAsync(bool,System.Threading.CancellationToken) and then calling StatusAsync(StatusItems,System.Threading.CancellationToken) on each of the returned folders.

public GetSubfoldersAsync ( StatusItems items, bool subscribedOnly = false, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
items	StatusItems	The status items to pre-populate.
subscribedOnly	bool	If set to true, only subscribed folders will be listed.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

GetSubfoldersAsync() public method

Asynchronously get the subfolders.

Asynchronously gets the subfolders.

public GetSubfoldersAsync ( bool subscribedOnly = false, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
subscribedOnly	bool	If set to true, only subscribed folders will be listed.
cancellationToken	System.Threading.CancellationToken	The cancellation token.
return	Task>

MailFolder() protected method

Initializes a new instance of the MailKit.MailFolder class.

protected MailFolder ( ) : System
return	System

MoveTo() public method

Move the specified message to the destination folder.

Moves the specified message to the destination folder.

/// is null. /// /// is invalid. /// -or- /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The mail store does not support the UIDPLUS extension. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public MoveTo ( UniqueId uid, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : UniqueId?
uid	UniqueId	The UID of the message to move.
destination	IMailFolder	The destination folder.
cancellationToken	CancellationToken	The cancellation token.
return	UniqueId?

MoveTo() public abstract method

Move the specified messages to the destination folder.

Moves the specified messages to the destination folder.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The mail store does not support the UIDPLUS extension. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract MoveTo ( IList uids, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : UniqueIdMap
uids	IList	The UIDs of the messages to move.
destination	IMailFolder	The destination folder.
cancellationToken	CancellationToken	The cancellation token.
return	UniqueIdMap

MoveTo() public abstract method

Move the specified messages to the destination folder.

Moves the specified messages to the destination folder.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract MoveTo ( IList indexes, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : void
indexes	IList	The indexes of the messages to move.
destination	IMailFolder	The destination folder.
cancellationToken	CancellationToken	The cancellation token.
return	void

MoveTo() public method

Move the specified message to the destination folder.

Moves the specified message to the destination folder.

/// is null. /// /// does not refer to a valid message index. /// /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public MoveTo ( int index, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : void
index	int	The index of the message to move.
destination	IMailFolder	The destination folder.
cancellationToken	CancellationToken	The cancellation token.
return	void

MoveToAsync() public method

Asynchronously move the specified messages to the destination folder.

Asynchronously moves the specified messages to the destination folder.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public MoveToAsync ( IList indexes, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task
indexes	IList	The indexes of the messages to move.
destination	IMailFolder	The destination folder.
cancellationToken	CancellationToken	The cancellation token.
return	Task

MoveToAsync() public method

Asynchronously move the specified message to the destination folder.

Asynchronously moves the specified message to the destination folder.

/// is null. /// /// does not refer to a valid message index. /// /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public MoveToAsync ( int index, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task
index	int	The index of the message to move.
destination	IMailFolder	The destination folder.
cancellationToken	CancellationToken	The cancellation token.
return	Task

MoveToAsync() public method

Asynchronously move the specified message to the destination folder.

Asynchronously moves the specified message to the destination folder.

/// is null. /// /// is invalid. /// -or- /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The mail store does not support the UIDPLUS extension. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public MoveToAsync ( UniqueId uid, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uid	UniqueId	The UID of the message to move.
destination	IMailFolder	The destination folder.
cancellationToken	CancellationToken	The cancellation token.
return	Task

MoveToAsync() public method

Asynchronously move the specified messages to the destination folder.

Asynchronously moves the specified messages to the destination folder.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// The destination folder does not belong to the . /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The mail store does not support the UIDPLUS extension. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public MoveToAsync ( IList uids, IMailFolder destination, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The UIDs of the messages to move.
destination	IMailFolder	The destination folder.
cancellationToken	CancellationToken	The cancellation token.
return	Task

OnClosed() protected method

Raise the closed event.

Raises the closed event.

protected OnClosed ( ) : void
return	void

OnCountChanged() protected method

Raise the count changed event.

Raises the count changed event.

protected OnCountChanged ( ) : void
return	void

OnDeleted() protected method

Raise the deleted event.

Raises the deleted event.

protected OnDeleted ( ) : void
return	void

OnHighestModSeqChanged() protected method

Raise the highest mod-sequence changed event.

Raises the highest mod-sequence changed event.

protected OnHighestModSeqChanged ( ) : void
return	void

OnMessageExpunged() protected method

Raise the message expunged event.

Raises the message expunged event.

protected OnMessageExpunged ( MessageEventArgs args ) : void
args	MessageEventArgs	The message expunged event args.
return	void

OnMessageFlagsChanged() protected method

Raise the message flags changed event.

Raises the message flags changed event.

protected OnMessageFlagsChanged ( MessageFlagsChangedEventArgs args ) : void
args	MessageFlagsChangedEventArgs	The message flags changed event args.
return	void

OnMessageLabelsChanged() protected method

Raise the message labels changed event.

Raises the message labels changed event.

protected OnMessageLabelsChanged ( MessageLabelsChangedEventArgs args ) : void
args	MessageLabelsChangedEventArgs	The message labels changed event args.
return	void

OnMessageSummaryFetched() protected method

Raise the message summary fetched event.

Raises the message summary fetched event.

When multiple message summaries are being fetched from a remote folder, it is possible that the connection will drop or some other exception will occur, causing the Fetch method to fail, requiring the client to request the same set of message summaries again after it reconnects. This is obviously inefficient. To alleviate this potential problem, this event will be emitted as soon as the IMailFolder successfully retrieves the complete IMessageSummary for each requested message.

The Fetch methods will return a list of all message summaries that any information was retrieved for, regardless of whether or not all of the requested items were fetched, therefore there may be a discrepency between the number of times this event is emitetd and the number of summary items returned from the Fetch method.

protected OnMessageSummaryFetched ( IMessageSummary message ) : void
message	IMessageSummary	The message summary.
return	void

OnMessagesArrived() protected method

Raise the messages arrived event.

Raises the messages arrived event.

protected OnMessagesArrived ( MessagesArrivedEventArgs args ) : void
args	MessagesArrivedEventArgs	The messages arrived event args.
return	void

OnMessagesVanished() protected method

Raise the messages vanished event.

Raises the messages vanished event.

protected OnMessagesVanished ( MessagesVanishedEventArgs args ) : void
args	MessagesVanishedEventArgs	The messages vanished event args.
return	void

OnModSeqChanged() protected method

Raise the message mod-sequence changed event.

Raises the message mod-sequence changed event.

protected OnModSeqChanged ( ModSeqChangedEventArgs args ) : void
args	ModSeqChangedEventArgs	The mod-sequence changed event args.
return	void

OnOpened() protected method

Raise the opened event.

Raises the opened event.

protected OnOpened ( ) : void
return	void

OnParentFolderRenamed() protected method

Notifies the folder that a parent folder has been renamed.

IMailFolder implementations should override this method to update their state (such as updating their FullName property).

protected OnParentFolderRenamed ( ) : void
return	void

OnRecentChanged() protected method

Raise the recent changed event.

Raises the recent changed event.

protected OnRecentChanged ( ) : void
return	void

OnRenamed() protected method

Raise the renamed event.

Raises the renamed event.

protected OnRenamed ( string oldName, string newName ) : void
oldName	string	The old name of the folder.
newName	string	The new name of the folder.
return	void

OnSubscribed() protected method

Raise the subscribed event.

Raises the subscribed event.

protected OnSubscribed ( ) : void
return	void

OnUidValidityChanged() protected method

Raise the uid validity changed event.

Raises the uid validity changed event.

protected OnUidValidityChanged ( ) : void
return	void

OnUnsubscribed() protected method

Raise the unsubscribed event.

Raises the unsubscribed event.

protected OnUnsubscribed ( ) : void
return	void

Open() public abstract method

Open the folder using the requested folder access.

Opens the folder using the requested folder access.

/// is not a valid value. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The does not exist. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Open ( FolderAccess access, CancellationToken cancellationToken = default(CancellationToken) ) : FolderAccess
access	FolderAccess	The requested folder access.
cancellationToken	CancellationToken	The cancellation token.
return	FolderAccess

Open() public abstract method

Opens the folder using the requested folder access.

This variant of the Open(FolderAccess,System.Threading.CancellationToken) method is meant for quick resynchronization of the folder. Before calling this method, the MailStore.EnableQuickResync(CancellationToken) method MUST be called.

You should also make sure to add listeners to the MessagesVanished and MessageFlagsChanged events to get notifications of changes since the last time the folder was opened.

/// is not a valid value. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The does not exist. /// /// The quick resynchronization feature has not been enabled. /// /// The mail store does not support the quick resynchronization feature. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Open ( FolderAccess access, uint uidValidity, ulong highestModSeq, IList uids, CancellationToken cancellationToken = default(CancellationToken) ) : FolderAccess
access	FolderAccess	The requested folder access.
uidValidity	uint	The last known value.
highestModSeq	ulong	The last known value.
uids	IList	The last known list of unique message identifiers.
cancellationToken	CancellationToken	The cancellation token.
return	FolderAccess

OpenAsync() public method

Asynchronously open the folder using the requested folder access.

Asynchronously opens the folder using the requested folder access.

public OpenAsync ( FolderAccess access, CancellationToken cancellationToken = default(CancellationToken) ) : Task
access	FolderAccess	The requested folder access.
cancellationToken	CancellationToken	The cancellation token.
return	Task

OpenAsync() public method

Asynchronously opens the folder using the requested folder access.

This variant of the OpenAsync(FolderAccess,System.Threading.CancellationToken) method is meant for quick resynchronization of the folder. Before calling this method, the MailStore.EnableQuickResync(CancellationToken) method MUST be called.

You should also make sure to add listeners to the MessagesVanished and MessageFlagsChanged events to get notifications of changes since the last time the folder was opened.

public OpenAsync ( FolderAccess access, uint uidValidity, ulong highestModSeq, IList uids, CancellationToken cancellationToken = default(CancellationToken) ) : Task
access	FolderAccess	The requested folder access.
uidValidity	uint	The last known value.
highestModSeq	ulong	The last known value.
uids	IList	The last known list of unique message identifiers.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveAccess() public abstract method

Remove all access rights for the given identity.

Removes all access rights for the given identity.

public abstract RemoveAccess ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : void
name	string	The identity name.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveAccessAsync() public method

Asynchronously remove all access rights for the given identity.

Asynchronously removes all access rights for the given identity.

public RemoveAccessAsync ( string name, CancellationToken cancellationToken = default(CancellationToken) ) : Task
name	string	The identity name.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveAccessRights() public abstract method

Remove access rights for the specified identity.

Removes the given access rights for the specified identity.

public abstract RemoveAccessRights ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : void
name	string	The identity name.
rights	AccessRights	The access rights.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveAccessRightsAsync() public method

Asynchronously remove access rights for the specified identity.

Asynchronously removes the given access rights for the specified identity.

public RemoveAccessRightsAsync ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : Task
name	string	The identity name.
rights	AccessRights	The access rights.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveFlags() public abstract method

Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

public abstract RemoveFlags ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

RemoveFlags() public method

Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

public RemoveFlags ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

RemoveFlags() public abstract method

Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

public abstract RemoveFlags ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

RemoveFlags() public method

Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

public RemoveFlags ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

RemoveFlags() public abstract method

Remove a set of flags from the specified messages.

Removes a set of flags from the specified messages.

public abstract RemoveFlags ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveFlags() public method

Remove a set of flags from the specified messages.

Removes a set of flags from the specified messages.

public RemoveFlags ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveFlags() public abstract method

Remove a set of flags from the specified messages.

Removes a set of flags from the specified messages.

/// is null. /// /// One or more of the is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract RemoveFlags ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveFlags() public method

Remove a set of flags from the specified messages.

Removes a set of flags from the specified messages.

/// is null. /// /// One or more of the is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public RemoveFlags ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveFlags() public method

Remove a set of flags from the specified message.

Removes a set of flags from the specified message.

public RemoveFlags ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uid	UniqueId	The UIDs of the message.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveFlags() public method

Remove a set of flags from the specified message.

Removes a set of flags from the specified message.

public RemoveFlags ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uid	UniqueId	The UIDs of the message.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveFlags() public method

Remove a set of flags from the specified message.

Removes a set of flags from the specified message.

public RemoveFlags ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
index	int	The index of the message.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveFlags() public method

Remove a set of flags from the specified message.

Removes a set of flags from the specified message.

public RemoveFlags ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
index	int	The index of the message.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified messages.

Asynchronously removes a set of flags from the specified messages.

public RemoveFlagsAsync ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified messages.

Asynchronously removes a set of flags from the specified messages.

public RemoveFlagsAsync ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified messages.

Asynchronously removes a set of flags from the specified messages.

/// is null. /// /// One or more of the is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public RemoveFlagsAsync ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified messages.

Asynchronously removes a set of flags from the specified messages.

/// is null. /// /// One or more of the is invalid. /// -or- /// No flags were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public RemoveFlagsAsync ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified message.

Asynchronously removes a set of flags from the specified message.

public RemoveFlagsAsync ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uid	UniqueId	The UID of the message.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified message.

Asynchronously removes a set of flags from the specified message.

public RemoveFlagsAsync ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uid	UniqueId	The UID of the message.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified message.

Asynchronously removes a set of flags from the specified message.

public RemoveFlagsAsync ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
index	int	The index of the message.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified message.

Asynchronously removes a set of flags from the specified message.

public RemoveFlagsAsync ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
index	int	The index of the message.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

public RemoveFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

public RemoveFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

public RemoveFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to remove.
userFlags	HashSet	A set of user-defined flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

RemoveFlagsAsync() public method

Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.

public RemoveFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

RemoveLabels() public abstract method

Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.

Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.

public abstract RemoveLabels ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

RemoveLabels() public abstract method

Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.

Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.

public abstract RemoveLabels ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

RemoveLabels() public abstract method

Remove a set of labels from the specified messages.

Removes a set of labels from the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// No labels were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract RemoveLabels ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uids	IList	The UIDs of the messages.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveLabels() public abstract method

Remove a set of labels from the specified messages.

Removes a set of labels from the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// No labels were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract RemoveLabels ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
indexes	IList	The indexes of the messages.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveLabels() public method

Remove a set of labels from the specified message.

Removes a set of labels from the specified message.

public RemoveLabels ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uid	UniqueId	The UIDs of the message.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveLabels() public method

Remove a set of labels from the specified message.

Removes a set of labels from the specified message.

public RemoveLabels ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
index	int	The index of the message.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

RemoveLabelsAsync() public method

Asynchronously remove a set of labels from the specified messages.

Asynchronously removes a set of labels from the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// No labels were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public RemoveLabelsAsync ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The UIDs of the messages.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveLabelsAsync() public method

Asynchronously remove a set of labels from the specified messages.

Asynchronously removes a set of labels from the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// -or- /// No labels were specified. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public RemoveLabelsAsync ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
indexes	IList	The indexes of the messages.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveLabelsAsync() public method

Asynchronously remove a set of labels from the specified message.

Asynchronously removes a set of labels from the specified message.

public RemoveLabelsAsync ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uid	UniqueId	The UID of the message.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveLabelsAsync() public method

Asynchronously remove a set of labels from the specified message.

Asynchronously removes a set of labels from the specified message.

public RemoveLabelsAsync ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
index	int	The index of the message.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

RemoveLabelsAsync() public method

Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.

public RemoveLabelsAsync ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

RemoveLabelsAsync() public method

Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.

public RemoveLabelsAsync ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to remove.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

Rename() public abstract method

Rename the folder.

Renames the folder.

/// is null. /// -or- /// is null. /// /// does not belong to the . /// -or- /// is not a legal folder name. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder cannot be renamed (it is either a namespace or the Inbox). /// /// The does not exist. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Rename ( IMailFolder parent, string name, CancellationToken cancellationToken = default(CancellationToken) ) : void
parent	IMailFolder	The new parent folder.
name	string	The new name of the folder.
cancellationToken	CancellationToken	The cancellation token.
return	void

RenameAsync() public method

Asynchronously rename the folder.

Asynchronously renames the folder.

public RenameAsync ( IMailFolder parent, string name, CancellationToken cancellationToken = default(CancellationToken) ) : Task
parent	IMailFolder	The new parent folder.
name	string	The new name of the folder.
cancellationToken	CancellationToken	The cancellation token.
return	Task

Search() public method

Search the subset of UIDs in the folder for messages matching the specified query.

The returned array of unique identifiers can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

/// is null. /// -or- /// is null. /// /// is empty. /// -or- /// One or more of the is invalid. /// /// One or more search terms in the are not supported by the mail store. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public Search ( IList uids, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The subset of UIDs
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	IList

Search() public abstract method

Search the folder for messages matching the specified query.

The returned array of unique identifiers can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

/// is null. /// /// One or more search terms in the are not supported by the mail store. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Search ( SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : IList
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	IList

Search() public method

Searches the subset of UIDs in the folder for messages matching the specified query.

Searches the fsubset of UIDs in the folder for messages matching the specified query, returning only the specified search results.

/// is null. /// -or- /// is null. /// /// is empty. /// -or- /// One or more of the is invalid. /// /// One or more search terms in the are not supported. /// -or- /// The server does not support the specified search options. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public Search ( SearchOptions options, IList uids, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : SearchResults
options	SearchOptions	The search options.
uids	IList	The subset of UIDs
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	SearchResults

Search() public abstract method

Search the folder for messages matching the specified query.

Searches the folder for messages matching the specified query, returning only the specified search results.

/// is null. /// /// One or more search terms in the are not supported. /// -or- /// The server does not support the specified search options. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Search ( SearchOptions options, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : SearchResults
options	SearchOptions	The search options.
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	SearchResults

SearchAsync() public method

Asynchronously search the subset of UIDs in the folder for messages matching the specified query.

The returned array of unique identifiers can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

/// is null. /// -or- /// is null. /// /// is empty. /// -or- /// One or more of the is invalid. /// /// One or more search terms in the are not supported. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SearchAsync ( IList uids, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The subset of UIDs
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

SearchAsync() public method

Asynchronously search the folder for messages matching the specified query.

The returned array of unique identifiers can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

public SearchAsync ( SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

SearchAsync() public method

Asynchronously searches the subset of UIDs in the folder for messages matching the specified query.

Asynchronously searches the fsubset of UIDs in the folder for messages matching the specified query, returning only the specified search results.

public SearchAsync ( SearchOptions options, IList uids, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task
options	SearchOptions	The search options.
uids	IList	The subset of UIDs
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SearchAsync() public method

Asynchronously search the folder for messages matching the specified query.

Asynchronously searches the folder for messages matching the specified query, returning only the specified search results.

public SearchAsync ( SearchOptions options, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task
options	SearchOptions	The search options.
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetAccessRights() public abstract method

Set the access rights for the specified identity.

Sets the access rights for the specified identity.

public abstract SetAccessRights ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : void
name	string	The identity name.
rights	AccessRights	The access rights.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetAccessRightsAsync() public method

Asynchronously set the access rights for the specified identity.

Asynchronously sets the access rights for the specified identity.

public SetAccessRightsAsync ( string name, AccessRights rights, CancellationToken cancellationToken = default(CancellationToken) ) : Task
name	string	The identity name.
rights	AccessRights	The access rights.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetFlags() public abstract method

Set the flags of the specified messages only if their mod-sequence value is less than the specified value.

Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.

/// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract SetFlags ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

SetFlags() public method

Set the flags of the specified messages only if their mod-sequence value is less than the specified value.

Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.

/// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SetFlags ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

SetFlags() public abstract method

Set the flags of the specified messages only if their mod-sequence value is less than the specified value.

Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.

/// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract SetFlags ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

SetFlags() public method

Set the flags of the specified messages only if their mod-sequence value is less than the specified value.

Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.

/// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SetFlags ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

SetFlags() public abstract method

Set the flags of the specified messages.

Sets the flags of the specified messages.

public abstract SetFlags ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetFlags() public method

Set the flags of the specified messages.

Sets the flags of the specified messages.

public SetFlags ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetFlags() public abstract method

Set the flags of the specified messages.

Sets the flags of the specified messages.

public abstract SetFlags ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetFlags() public method

Set the flags of the specified messages.

Sets the flags of the specified messages.

public SetFlags ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetFlags() public method

Set the flags of the specified message.

Sets the flags of the specified message.

/// is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SetFlags ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uid	UniqueId	The UIDs of the message.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetFlags() public method

Set the flags of the specified message.

Sets the flags of the specified message.

/// is invalid. /// /// The has been disposed. /// /// The folder is not currently open in read-write mode. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SetFlags ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uid	UniqueId	The UIDs of the message.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetFlags() public method

Set the flags of the specified message.

Sets the flags of the specified message.

public SetFlags ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
index	int	The index of the message.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetFlags() public method

Set the flags of the specified message.

Sets the flags of the specified message.

public SetFlags ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
index	int	The index of the message.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetFlagsAsync() public method

Asynchronously set the flags of the specified messages.

Asynchronously sets the flags of the specified messages.

public SetFlagsAsync ( IList uids, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetFlagsAsync() public method

Asynchronously set the flags of the specified messages.

Asynchronously sets the flags of the specified messages.

public SetFlagsAsync ( IList uids, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The UIDs of the messages.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetFlagsAsync() public method

Asynchronously set the flags of the specified messages.

Asynchronously sets the flags of the specified messages.

public SetFlagsAsync ( IList indexes, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetFlagsAsync() public method

Asynchronously set the flags of the specified messages.

Asynchronously sets the flags of the specified messages.

public SetFlagsAsync ( IList indexes, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
indexes	IList	The indexes of the messages.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetFlagsAsync() public method

Asynchronously set the flags of the specified message.

Asynchronously sets the flags of the specified message.

public SetFlagsAsync ( UniqueId uid, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uid	UniqueId	The UID of the message.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetFlagsAsync() public method

Asynchronously set the flags of the specified message.

Asynchronously sets the flags of the specified message.

public SetFlagsAsync ( UniqueId uid, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uid	UniqueId	The UID of the message.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetFlagsAsync() public method

Asynchronously set the flags of the specified message.

Asynchronously sets the flags of the specified message.

public SetFlagsAsync ( int index, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
index	int	The index of the message.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetFlagsAsync() public method

Asynchronously set the flags of the specified message.

Asynchronously sets the flags of the specified message.

public SetFlagsAsync ( int index, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
index	int	The index of the message.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetFlagsAsync() public method

Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.

/// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SetFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

SetFlagsAsync() public method

Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.

/// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SetFlagsAsync ( IList uids, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

SetFlagsAsync() public method

Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.

/// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SetFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, HashSet userFlags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to set.
userFlags	HashSet	A set of user-defined flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

SetFlagsAsync() public method

Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.

/// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SetFlagsAsync ( IList indexes, ulong modseq, MessageFlags flags, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
flags	MessageFlags	The message flags to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

SetLabels() public abstract method

Set the labels of the specified messages only if their mod-sequence value is less than the specified value.

Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The does not support mod-sequences. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract SetLabels ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

SetLabels() public abstract method

Set the labels of the specified messages only if their mod-sequence value is less than the specified value.

Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.

public abstract SetLabels ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : IList
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	IList

SetLabels() public abstract method

Set the labels of the specified messages.

Sets the labels of the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract SetLabels ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uids	IList	The UIDs of the messages.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetLabels() public abstract method

Set the labels of the specified messages.

Sets the labels of the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract SetLabels ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
indexes	IList	The indexes of the messages.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetLabels() public method

Set the labels of the specified message.

Sets the labels of the specified message.

/// is null. /// /// is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SetLabels ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
uid	UniqueId	The UIDs of the message.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetLabels() public method

Set the labels of the specified message.

Sets the labels of the specified message.

public SetLabels ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : void
index	int	The index of the message.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetLabelsAsync() public method

Asynchronously set the labels of the specified messages.

Asynchronously sets the labels of the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SetLabelsAsync ( IList uids, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uids	IList	The UIDs of the messages.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetLabelsAsync() public method

Asynchronously set the labels of the specified messages.

Asynchronously sets the labels of the specified messages.

/// is null. /// -or- /// is null. /// /// One or more of the is invalid. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open in read-write mode. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SetLabelsAsync ( IList indexes, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
indexes	IList	The indexes of the messages.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetLabelsAsync() public method

Asynchronously set the labels of the specified message.

Asynchronously sets the labels of the specified message.

public SetLabelsAsync ( UniqueId uid, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
uid	UniqueId	The UID of the message.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetLabelsAsync() public method

Asynchronously set the labels of the specified message.

Asynchronously sets the labels of the specified message.

public SetLabelsAsync ( int index, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task
index	int	The index of the message.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetLabelsAsync() public method

Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.

public SetLabelsAsync ( IList uids, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The UIDs of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

SetLabelsAsync() public method

Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.

Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.

public SetLabelsAsync ( IList indexes, ulong modseq, IList labels, bool silent, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
indexes	IList	The indexes of the messages.
modseq	ulong	The mod-sequence value.
labels	IList	The labels to set.
silent	bool	If set to true, no events will be emitted.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

SetMetadata() public abstract method

Sets the specified metadata.

public abstract SetMetadata ( MetadataCollection metadata, CancellationToken cancellationToken = default(CancellationToken) ) : void
metadata	MetadataCollection	The metadata.
cancellationToken	CancellationToken	The cancellation token.
return	void

SetMetadataAsync() public method

Asynchronously sets the specified metadata.

public SetMetadataAsync ( MetadataCollection metadata, CancellationToken cancellationToken = default(CancellationToken) ) : Task
metadata	MetadataCollection	The metadata.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SetQuota() public abstract method

Set the quota limits for the folder.

Sets the quota limits for the folder.

To determine if a quotas are supported, check the IMailStore.SupportsQuotas property.

public abstract SetQuota ( uint messageLimit, uint storageLimit, CancellationToken cancellationToken = default(CancellationToken) ) : FolderQuota
messageLimit	uint	If not null, sets the maximum number of messages to allow.
storageLimit	uint	If not null, sets the maximum storage size (in kilobytes).
cancellationToken	CancellationToken	The cancellation token.
return	FolderQuota

SetQuotaAsync() public method

Asynchronously set the quota limits for the folder.

Asynchronously sets the quota limits for the folder.

To determine if a quotas are supported, check the IMailStore.SupportsQuotas property.

public SetQuotaAsync ( uint messageLimit, uint storageLimit, CancellationToken cancellationToken = default(CancellationToken) ) : Task
messageLimit	uint	If not null, sets the maximum number of messages to allow.
storageLimit	uint	If not null, sets the maximum storage size (in kilobytes).
cancellationToken	CancellationToken	The cancellation token.
return	Task

Sort() public method

Sort messages matching the specified query.

The returned array of unique identifiers will be sorted in the preferred order and can be used with IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

/// is null. /// -or- /// is null. /// -or- /// is null. /// /// is empty. /// -or- /// One or more of the is invalid. /// -or- /// is empty. /// /// One or more search terms in the are not supported. /// -or- /// The server does not support sorting search results. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public Sort ( IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The subset of UIDs
query	SearchQuery	The search query.
orderBy	IList	The sort order.
cancellationToken	CancellationToken	The cancellation token.
return	IList

Sort() public abstract method

Sort messages matching the specified query.

The returned array of unique identifiers will be sorted in the preferred order and can be used with IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

/// is null. /// -or- /// is null. /// /// is empty. /// /// One or more search terms in the are not supported. /// -or- /// The server does not support sorting search results. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Sort ( SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : IList
query	SearchQuery	The search query.
orderBy	IList	The sort order.
cancellationToken	CancellationToken	The cancellation token.
return	IList

Sort() public method

Sort messages matching the specified query.

Searches the folder for messages matching the specified query, returning the search results in the specified sort order.

/// is null. /// -or- /// is null. /// -or- /// is null. /// /// is empty. /// -or- /// One or more of the is invalid. /// -or- /// is empty. /// /// One or more search terms in the are not supported. /// -or- /// The server does not support the specified search options. /// -or- /// The server does not support sorting search results. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public Sort ( SearchOptions options, IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : SearchResults
options	SearchOptions	The search options.
uids	IList	The subset of UIDs
query	SearchQuery	The search query.
orderBy	IList	The sort order.
cancellationToken	CancellationToken	The cancellation token.
return	SearchResults

Sort() public abstract method

Sort messages matching the specified query.

Searches the folder for messages matching the specified query, returning the search results in the specified sort order.

/// is null. /// -or- /// is null. /// /// is empty. /// /// One or more search terms in the are not supported. /// -or- /// The server does not support the specified search options. /// -or- /// The server does not support sorting search results. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Sort ( SearchOptions options, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : SearchResults
options	SearchOptions	The search options.
query	SearchQuery	The search query.
orderBy	IList	The sort order.
cancellationToken	CancellationToken	The cancellation token.
return	SearchResults

SortAsync() public method

Asynchronously sort messages matching the specified query.

The returned array of unique identifiers will be sorted in the preferred order and can be used with IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

public SortAsync ( IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The subset of UIDs
query	SearchQuery	The search query.
orderBy	IList	The sort order.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

SortAsync() public method

Asynchronously sort messages matching the specified query.

The returned array of unique identifiers will be sorted in the preferred order and can be used with IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

public SortAsync ( SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
query	SearchQuery	The search query.
orderBy	IList	The sort order.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

SortAsync() public method

Asynchronously sort messages matching the specified query, returning the search results in the specified sort order.

Asynchronously searches the folder for messages matching the specified query, returning the search results in the specified sort order.

/// is null. /// -or- /// is null. /// -or- /// is null. /// /// is empty. /// -or- /// One or more of the is invalid. /// -or- /// is empty. /// /// One or more search terms in the are not supported. /// -or- /// The server does not support the specified search options. /// -or- /// The server does not support sorting search results. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public SortAsync ( SearchOptions options, IList uids, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task
options	SearchOptions	The search options.
uids	IList	The subset of UIDs
query	SearchQuery	The search query.
orderBy	IList	The sort order.
cancellationToken	CancellationToken	The cancellation token.
return	Task

SortAsync() public method

Asynchronously sort messages matching the specified query.

Asynchronously searches the folder for messages matching the specified query, returning the search results in the specified sort order.

public SortAsync ( SearchOptions options, SearchQuery query, IList orderBy, CancellationToken cancellationToken = default(CancellationToken) ) : Task
options	SearchOptions	The search options.
query	SearchQuery	The search query.
orderBy	IList	The sort order.
cancellationToken	CancellationToken	The cancellation token.
return	Task

Status() public abstract method

Update the values of the specified items.

Updates the values of the specified items.

The Status(StatusItems, System.Threading.CancellationToken) method MUST NOT be used on a folder that is already in the opened state. Instead, other ways of getting the desired information should be used.

For example, a common use for the Status(StatusItems,System.Threading.CancellationToken) method is to get the number of unread messages in the folder. When the folder is open, however, it is possible to use the MailFolder.Search(MailKit.Search.SearchQuery, System.Threading.CancellationToken) method to query for the list of unread messages.

/// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The does not exist. /// /// The mail store does not support the STATUS command. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Status ( StatusItems items, CancellationToken cancellationToken = default(CancellationToken) ) : void
items	StatusItems	The items to update.
cancellationToken	CancellationToken	The cancellation token.
return	void

StatusAsync() public method

Asynchronously update the values of the specified items.

Updates the values of the specified items.

/// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The mail store does not support the STATUS command. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public StatusAsync ( StatusItems items, CancellationToken cancellationToken = default(CancellationToken) ) : Task
items	StatusItems	The items to update.
cancellationToken	CancellationToken	The cancellation token.
return	Task

Subscribe() public abstract method

Subscribe to the folder.

Subscribes to the folder.

public abstract Subscribe ( CancellationToken cancellationToken = default(CancellationToken) ) : void
cancellationToken	CancellationToken	The cancellation token.
return	void

SubscribeAsync() public method

Asynchronously subscribe to the folder.

Asynchronously subscribes to the folder.

public SubscribeAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task
cancellationToken	CancellationToken	The cancellation token.
return	Task

Thread() public abstract method

Thread the messages in the folder that match the search query using the specified threading algorithm.

The MessageThread.UniqueId can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

/// is not supported. /// /// is null. /// -or- /// is null. /// /// is empty. /// -or- /// One or more of the is invalid. /// /// One or more search terms in the are not supported. /// -or- /// The server does not support threading search results. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Thread ( IList uids, ThreadingAlgorithm algorithm, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : IList
uids	IList	The subset of UIDs
algorithm	ThreadingAlgorithm	The threading algorithm to use.
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	IList

Thread() public abstract method

Thread the messages in the folder that match the search query using the specified threading algorithm.

The MessageThread.UniqueId can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

/// is not supported. /// /// is null. /// /// One or more search terms in the are not supported. /// -or- /// The server does not support threading search results. /// /// The has been disposed. /// /// The is not connected. /// /// The is not authenticated. /// /// The folder is not currently open. /// /// The operation was canceled via the cancellation token. /// /// An I/O error occurred. /// /// The server's response contained unexpected tokens. /// /// The command failed. ///

public abstract Thread ( ThreadingAlgorithm algorithm, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : IList
algorithm	ThreadingAlgorithm	The threading algorithm to use.
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	IList

ThreadAsync() public method

Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.

The MessageThread.UniqueId can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

public ThreadAsync ( IList uids, ThreadingAlgorithm algorithm, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
uids	IList	The subset of UIDs
algorithm	ThreadingAlgorithm	The threading algorithm to use.
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

ThreadAsync() public method

Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.

The MessageThread.UniqueId can be used with methods such as IMailFolder.GetMessage(UniqueId,CancellationToken,ITransferProgress).

public ThreadAsync ( ThreadingAlgorithm algorithm, SearchQuery query, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
algorithm	ThreadingAlgorithm	The threading algorithm to use.
query	SearchQuery	The search query.
cancellationToken	CancellationToken	The cancellation token.
return	Task>

ToString() public method

Returns a System.String that represents the current MailKit.MailFolder.

public ToString ( ) : string
return	string

Unsubscribe() public abstract method

Unsubscribe from the folder.

Unsubscribes from the folder.

public abstract Unsubscribe ( CancellationToken cancellationToken = default(CancellationToken) ) : void
cancellationToken	CancellationToken	The cancellation token.
return	void

UnsubscribeAsync() public method

Asynchronously unsubscribe from the folder.

Asynchronously unsubscribes from the folder.

public UnsubscribeAsync ( CancellationToken cancellationToken = default(CancellationToken) ) : Task
cancellationToken	CancellationToken	The cancellation token.
return	Task

Property Details

SettableFlags protected static property

The bit mask of settable flags.

Only flags in the list of settable flags may be set on a message by the client.

protected static MessageFlags SettableFlags
return	MessageFlags