View on GitHub

MailKit

MailKit: A cross-platform .NET mail-client library optimized for mobile.

Download this project as a .zip file Download this project as a tar.gz file

IFolder Interface

An interface for a mailbox folder as used by MailKit.IMessageStore.

Syntax

public interface IFolder : IEnumerable<MimeKit.MimeMessage>

Remarks

Implemented by message stores such as MailKit.Net.Imap.ImapClient

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Members

Public Properties

[read-only]
AcceptedFlags MessageFlags . Gets the accepted flags.
[read-only]
Access FolderAccess . Gets the read/write access of the folder.
[read-only]
Attributes FolderAttributes . Gets the folder attributes.
[read-only]
Count int . Gets the total number of messages in the folder.
[read-only]
DirectorySeparator char . Gets the directory separator.
[read-only]
Exists bool . Gets a value indicating whether the folder exists.
[read-only]
FirstUnread int . Gets the index of the first unread message in the folder.
[read-only]
FullName string . Gets the full name of the folder.
[read-only]
HighestModSeq ulong . Gets the highest mod-sequence value of all messages in the mailbox.
[read-only]
IsNamespace bool . Gets whether or not the folder is a namespace folder.
[read-only]
IsOpen bool . Gets a value indicating whether the folder is currently open.
[read-only]
IsSubscribed bool . Gets a value indicating whether the folder is subscribed.
[read-only]
Name string . Gets the name of the folder.
[read-only]
ParentFolder IFolder . Gets the parent folder.
[read-only]
PermanentFlags MessageFlags . Gets the permanent flags.
[read-only]
Recent int . Gets the number of recently added messages.
[read-only]
SupportsModSeq bool . Gets whether or not the folder supports mod-sequences.
[read-only]
UidNext Nullable<UniqueId> . Gets the UID that the next message that is added to the folder will be assigned.
[read-only]
UidValidity Nullable<UniqueId> . Gets the Unique ID validity.

Public Methods

AddFlags (UniqueId[], MessageFlags, bool)
Adds a set of flags to the specified messages.
AddFlags (int[], MessageFlags, bool)
Adds a set of flags to the specified messages.
AddFlags (UniqueId[], MessageFlags, bool, System.Threading.CancellationToken)
Adds a set of flags to the specified messages.
AddFlags (UniqueId[], ulong, MessageFlags, bool) : UniqueId[]
Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
AddFlags (int[], MessageFlags, bool, System.Threading.CancellationToken)
Adds a set of flags to the specified messages.
AddFlags (int[], ulong, MessageFlags, bool) : int[]
Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
AddFlags (UniqueId[], ulong, MessageFlags, bool, System.Threading.CancellationToken) : UniqueId[]
Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
AddFlags (int[], ulong, MessageFlags, bool, System.Threading.CancellationToken) : int[]
Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
Append (MimeKit.MimeMessage, MessageFlags) : Nullable<UniqueId>
Appends the specified message to the folder.
Append (MimeKit.MimeMessage[], MessageFlags[]) : UniqueId[]
Appends the specified messages to the folder.
Append (MimeKit.MimeMessage, MessageFlags, DateTimeOffset) : Nullable<UniqueId>
Appends the specified message to the folder.
Append (MimeKit.MimeMessage, MessageFlags, System.Threading.CancellationToken) : Nullable<UniqueId>
Appends the specified message to the folder.
Append (MimeKit.MimeMessage[], MessageFlags[], DateTimeOffset[]) : UniqueId[]
Appends the specified messages to the folder.
Append (MimeKit.MimeMessage[], MessageFlags[], System.Threading.CancellationToken) : UniqueId[]
Appends the specified messages to the folder.
Append (MimeKit.MimeMessage, MessageFlags, DateTimeOffset, System.Threading.CancellationToken) : Nullable<UniqueId>
Appends the specified message to the folder.
Append (MimeKit.MimeMessage[], MessageFlags[], DateTimeOffset[], System.Threading.CancellationToken) : UniqueId[]
Appends the specified messages to the folder.
Check ()
Forces the server to flush its state for the folder.
Check (System.Threading.CancellationToken)
Forces the server to flush its state for the folder.
Close (bool)
Closes the folder, optionally expunging the messages marked for deletion.
Close (bool, System.Threading.CancellationToken)
Closes the folder, optionally expunging the messages marked for deletion.
CopyTo (UniqueId[], IFolder) : UniqueId[]
Copies the specified messages to the destination folder.
CopyTo (int[], IFolder)
Copies the specified messages to the destination folder.
CopyTo (UniqueId[], IFolder, System.Threading.CancellationToken) : UniqueId[]
Copies the specified messages to the destination folder.
CopyTo (int[], IFolder, System.Threading.CancellationToken)
Copies the specified messages to the destination folder.
Create (string, bool) : IFolder
Creates a new subfolder with the given name.
Create (string, bool, System.Threading.CancellationToken) : IFolder
Creates a new subfolder with the given name.
Delete ()
Deletes the folder on the IMAP server.
Delete (System.Threading.CancellationToken)
Deletes the folder on the IMAP server.
Expunge ()
Expunges the folder, permanently removing all messages marked for deletion.
Expunge (UniqueId[])
Expunges the specified uids, permanently removing them from the folder.
Expunge (System.Threading.CancellationToken)
Expunges the folder, permanently removing all messages marked for deletion.
Expunge (UniqueId[], System.Threading.CancellationToken)
Expunges the specified uids, permanently removing them from the folder.
Fetch (UniqueId[], MessageSummaryItems) : IEnumerable<MessageSummary>
Fetches the message summaries for the specified message UIDs.
Fetch (int[], MessageSummaryItems) : IEnumerable<MessageSummary>
Fetches the message summaries for the specified message indexes.
Fetch (UniqueId, Nullable<UniqueId>, MessageSummaryItems) : IEnumerable<MessageSummary>
Fetches the message summaries for the messages between the two UIDs, inclusive.
Fetch (UniqueId[], MessageSummaryItems, System.Threading.CancellationToken) : IEnumerable<MessageSummary>
Fetches the message summaries for the specified message UIDs.
Fetch (UniqueId[], ulong, MessageSummaryItems) : IEnumerable<MessageSummary>
Fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.
Fetch (int, int, MessageSummaryItems) : IEnumerable<MessageSummary>
Fetches the message summaries for the messages between the two indexes, inclusive.
Fetch (int[], MessageSummaryItems, System.Threading.CancellationToken) : IEnumerable<MessageSummary>
Fetches the message summaries for the specified message indexes.
Fetch (int[], ulong, MessageSummaryItems) : IEnumerable<MessageSummary>
Fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.
Fetch (UniqueId, Nullable<UniqueId>, MessageSummaryItems, System.Threading.CancellationToken) : IEnumerable<MessageSummary>
Fetches the message summaries for the messages between the two UIDs, inclusive.
Fetch (UniqueId, Nullable<UniqueId>, ulong, MessageSummaryItems) : IEnumerable<MessageSummary>
Fetches the message summaries for the messages between the two UIDs (inclusive) that have a higher mod-sequence value than the one specified.
Fetch (UniqueId[], ulong, MessageSummaryItems, System.Threading.CancellationToken) : IEnumerable<MessageSummary>
Fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.
Fetch (int, int, MessageSummaryItems, System.Threading.CancellationToken) : IEnumerable<MessageSummary>
Fetches the message summaries for the messages between the two indexes, inclusive.
Fetch (int, int, ulong, MessageSummaryItems) : IEnumerable<MessageSummary>
Fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.
Fetch (int[], ulong, MessageSummaryItems, System.Threading.CancellationToken) : IEnumerable<MessageSummary>
Fetches the message summaries for the specified message indexes that have a higher mod-sequence value than the one specified.
Fetch (UniqueId, Nullable<UniqueId>, ulong, MessageSummaryItems, System.Threading.CancellationToken) : IEnumerable<MessageSummary>
Fetches the message summaries for the messages between the two UIDs (inclusive) that have a higher mod-sequence value than the one specified.
Fetch (int, int, ulong, MessageSummaryItems, System.Threading.CancellationToken) : IEnumerable<MessageSummary>
Fetches the message summaries for the messages between the two indexes (inclusive) that have a higher mod-sequence value than the one specified.
GetBodyPart (UniqueId, BodyPart, bool) : MimeKit.MimeEntity
Gets the specified body part.
GetBodyPart (UniqueId, BodyPart, System.Threading.CancellationToken) : MimeKit.MimeEntity
Gets the specified body part.
GetBodyPart (int, BodyPart, bool) : MimeKit.MimeEntity
Gets the specified body part.
GetBodyPart (int, BodyPart, System.Threading.CancellationToken) : MimeKit.MimeEntity
Gets the specified body part.
GetBodyPart (UniqueId, BodyPart, bool, System.Threading.CancellationToken) : MimeKit.MimeEntity
Gets the specified body part.
GetBodyPart (int, BodyPart, bool, System.Threading.CancellationToken) : MimeKit.MimeEntity
Gets the specified body part.
GetMessage (UniqueId) : MimeKit.MimeMessage
Gets the specified message.
GetMessage (int) : MimeKit.MimeMessage
Gets the specified message.
GetMessage (UniqueId, System.Threading.CancellationToken) : MimeKit.MimeMessage
Gets the specified message.
GetMessage (int, System.Threading.CancellationToken) : MimeKit.MimeMessage
Gets the specified message.
GetStream (UniqueId, int, int) : System.IO.Stream
Gets a substream of the specified message.
GetStream (int, int, int) : System.IO.Stream
Gets a substream of the specified message.
GetStream (UniqueId, BodyPart, int, int) : System.IO.Stream
Gets a substream of the specified body part.
GetStream (UniqueId, int, int, System.Threading.CancellationToken) : System.IO.Stream
Gets a substream of the specified message.
GetStream (int, BodyPart, int, int) : System.IO.Stream
Gets a substream of the specified body part.
GetStream (int, int, int, System.Threading.CancellationToken) : System.IO.Stream
Gets a substream of the specified message.
GetStream (UniqueId, BodyPart, int, int, System.Threading.CancellationToken) : System.IO.Stream
Gets a substream of the specified body part.
GetStream (int, BodyPart, int, int, System.Threading.CancellationToken) : System.IO.Stream
Gets a substream of the specified body part.
GetSubfolder (string) : IFolder
Gets the specified subfolder.
GetSubfolder (string, System.Threading.CancellationToken) : IFolder
Gets the specified subfolder.
GetSubfolders (bool) : IEnumerable<IFolder>
Gets the subfolders.
GetSubfolders (bool, System.Threading.CancellationToken) : IEnumerable<IFolder>
Gets the subfolders.
MoveTo (UniqueId[], IFolder) : UniqueId[]
Moves the specified messages to the destination folder.
MoveTo (int[], IFolder)
Moves the specified messages to the destination folder.
MoveTo (UniqueId[], IFolder, System.Threading.CancellationToken) : UniqueId[]
Moves the specified messages to the destination folder.
MoveTo (int[], IFolder, System.Threading.CancellationToken)
Moves the specified messages to the destination folder.
Open (FolderAccess) : FolderAccess
Opens the folder using the requested folder access.
Open (FolderAccess, System.Threading.CancellationToken) : FolderAccess
Opens the folder using the requested folder access.
RemoveFlags (UniqueId[], MessageFlags, bool)
Removes a set of flags from the specified messages.
RemoveFlags (int[], MessageFlags, bool)
Removes a set of flags from the specified messages.
RemoveFlags (UniqueId[], MessageFlags, bool, System.Threading.CancellationToken)
Removes a set of flags from the specified messages.
RemoveFlags (UniqueId[], ulong, MessageFlags, bool) : UniqueId[]
Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
RemoveFlags (int[], MessageFlags, bool, System.Threading.CancellationToken)
Removes a set of flags from the specified messages.
RemoveFlags (int[], ulong, MessageFlags, bool) : int[]
Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
RemoveFlags (UniqueId[], ulong, MessageFlags, bool, System.Threading.CancellationToken) : UniqueId[]
Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
RemoveFlags (int[], ulong, MessageFlags, bool, System.Threading.CancellationToken) : int[]
Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
Rename (IFolder, string)
Renames the folder to exist with a new name under a new parent folder.
Rename (IFolder, string, System.Threading.CancellationToken)
Renames the folder to exist with a new name under a new parent folder.
Search (MailKit.Search.SearchQuery) : UniqueId[]
Searches the folder for messages matching the specified query.
Search (MailKit.Search.SearchQuery, MailKit.Search.OrderBy[]) : UniqueId[]
Searches the folder for messages matching the specified query, returning them in the preferred sort order.
Search (MailKit.Search.SearchQuery, System.Threading.CancellationToken) : UniqueId[]
Searches the folder for messages matching the specified query.
Search (UniqueId[], MailKit.Search.SearchQuery) : UniqueId[]
Searches the subset of UIDs in the folder for messages matching the specified query.
Search (MailKit.Search.SearchQuery, MailKit.Search.OrderBy[], System.Threading.CancellationToken) : UniqueId[]
Searches the folder for messages matching the specified query, returning them in the preferred sort order.
Search (UniqueId[], MailKit.Search.SearchQuery, MailKit.Search.OrderBy[]) : UniqueId[]
Searches the subset of UIDs in the folder for messages matching the specified query, returning them in the preferred sort order.
Search (UniqueId[], MailKit.Search.SearchQuery, System.Threading.CancellationToken) : UniqueId[]
Searches the subset of UIDs in the folder for messages matching the specified query.
Search (UniqueId[], MailKit.Search.SearchQuery, MailKit.Search.OrderBy[], System.Threading.CancellationToken) : UniqueId[]
Searches the subset of UIDs in the folder for messages matching the specified query, returning them in the preferred sort order.
SetFlags (UniqueId[], MessageFlags, bool)
Sets the flags of the specified messages.
SetFlags (int[], MessageFlags, bool)
Sets the flags of the specified messages.
SetFlags (UniqueId[], MessageFlags, bool, System.Threading.CancellationToken)
Sets the flags of the specified messages.
SetFlags (UniqueId[], ulong, MessageFlags, bool) : UniqueId[]
Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
SetFlags (int[], MessageFlags, bool, System.Threading.CancellationToken)
Sets the flags of the specified messages.
SetFlags (int[], ulong, MessageFlags, bool) : int[]
Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
SetFlags (UniqueId[], ulong, MessageFlags, bool, System.Threading.CancellationToken) : UniqueId[]
Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
SetFlags (int[], ulong, MessageFlags, bool, System.Threading.CancellationToken) : int[]
Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
Status (StatusItems)
Updates the values of the specified items.
Status (StatusItems, System.Threading.CancellationToken)
Updates the values of the specified items.
Subscribe ()
Subscribes the folder.
Subscribe (System.Threading.CancellationToken)
Subscribes the folder.
Thread (ThreadingAlgorithm, MailKit.Search.SearchQuery) : MessageThread[]
Threads the messages in the folder that match the search query using the specified threading algorithm.
Thread (ThreadingAlgorithm, MailKit.Search.SearchQuery, System.Threading.CancellationToken) : MessageThread[]
Threads the messages in the folder that match the search query using the specified threading algorithm.
Thread (UniqueId[], ThreadingAlgorithm, MailKit.Search.SearchQuery) : MessageThread[]
Threads the messages in the folder that match the search query using the specified threading algorithm.
Thread (UniqueId[], ThreadingAlgorithm, MailKit.Search.SearchQuery, System.Threading.CancellationToken) : MessageThread[]
Threads the messages in the folder that match the search query using the specified threading algorithm.
Unsubscribe ()
Unsubscribes the folder.
Unsubscribe (System.Threading.CancellationToken)
Unsubscribes the folder.

Public Events

CountChanged Occurs when the message count changes.
Deleted Occurs when the folder is deleted.
Expunged Occurs when a message is expunged from the folder.
MessageFlagsChanged Occurs when flags changed on a message.
RecentChanged Occurs when the recent message count changes.
Renamed Occurs when the folder is renamed.
Subscribed Occurs when the folder is subscribed.
UidValidityChanged Occurs when the UID validity changes.
Unsubscribed Occurs when the folder is unsubscribed.

Member Details

AcceptedFlags Property

Gets the accepted flags.

Syntax

public MessageFlags AcceptedFlags { get; }

Value

The accepted flags.

Remarks

The accepted flags are the message flags that will be accepted and persist for the current session. For the set of flags that will persist between sessions, see the IFolder.PermanentFlags property.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Access Property

Gets the read/write access of the folder.

Syntax

public FolderAccess Access { get; }

Value

The read/write access.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

AddFlags Method

Adds a set of flags to the specified messages.

Syntax

public void AddFlags (UniqueId[] uids, MessageFlags flags, bool silent)

Parameters

uids
The UIDs of the messages.
flags
The message flags to add.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

AddFlags Method

Adds a set of flags to the specified messages.

Syntax

public void AddFlags (int[] indexes, MessageFlags flags, bool silent)

Parameters

indexes
The indexes of the messages.
flags
The message flags to add.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

AddFlags Method

Adds a set of flags to the specified messages.

Syntax

public void AddFlags (UniqueId[] uids, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The UIDs of the messages.
flags
The message flags to add.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

AddFlags Method

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

Syntax

public UniqueId[] AddFlags (UniqueId[] uids, ulong modseq, MessageFlags flags, bool silent)

Parameters

uids
The UIDs of the messages.
modseq
The mod-sequence value.
flags
The message flags to add.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Returns

The unique IDs of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

AddFlags Method

Adds a set of flags to the specified messages.

Syntax

public void AddFlags (int[] indexes, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

indexes
The indexes of the messages.
flags
The message flags to add.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

AddFlags Method

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

Syntax

public int[] AddFlags (int[] indexes, ulong modseq, MessageFlags flags, bool silent)

Parameters

indexes
The indexes of the messages.
modseq
The mod-sequence value.
flags
The message flags to add.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Returns

The indexes of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

AddFlags Method

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

Syntax

public UniqueId[] AddFlags (UniqueId[] uids, ulong modseq, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The UIDs of the messages.
modseq
The mod-sequence value.
flags
The message flags to add.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Returns

The unique IDs of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

AddFlags Method

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

Syntax

public int[] AddFlags (int[] indexes, ulong modseq, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

indexes
The indexes of the messages.
modseq
The mod-sequence value.
flags
The message flags to add.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Returns

The indexes of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Append Method

Appends the specified message to the folder.

Syntax

public Nullable<UniqueId> Append (MimeKit.MimeMessage message, MessageFlags flags)

Parameters

message
The message.
flags
The message flags.

Returns

The UID of the appended message, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Append Method

Appends the specified messages to the folder.

Syntax

public UniqueId[] Append (MimeKit.MimeMessage[] messages, MessageFlags[] flags)

Parameters

messages
The array of messages to append to the folder.
flags
The message flags to use for each message.

Returns

The UIDs of the appended messages, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Append Method

Appends the specified message to the folder.

Syntax

Parameters

message
The message.
flags
The message flags.
date
The received date of the message.

Returns

The UID of the appended message, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Append Method

Appends the specified message to the folder.

Syntax

Parameters

message
The message.
flags
The message flags.
cancellationToken
The cancellation token.

Returns

The UID of the appended message, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Append Method

Appends the specified messages to the folder.

Syntax

public UniqueId[] Append (MimeKit.MimeMessage[] messages, MessageFlags[] flags, DateTimeOffset[] dates)

Parameters

messages
The array of messages to append to the folder.
flags
The message flags to use for each of the messages.
dates
The received dates to use for each of the messages.

Returns

The UIDs of the appended messages, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Append Method

Appends the specified messages to the folder.

Syntax

public UniqueId[] Append (MimeKit.MimeMessage[] messages, MessageFlags[] flags, System.Threading.CancellationToken cancellationToken)

Parameters

messages
The array of messages to append to the folder.
flags
The message flags to use for each message.
cancellationToken
The cancellation token.

Returns

The UIDs of the appended messages, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Append Method

Appends the specified message to the folder.

Syntax

Parameters

message
The message.
flags
The message flags.
date
The received date of the message.
cancellationToken
The cancellation token.

Returns

The UID of the appended message, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Append Method

Appends the specified messages to the folder.

Syntax

public UniqueId[] Append (MimeKit.MimeMessage[] messages, MessageFlags[] flags, DateTimeOffset[] dates, System.Threading.CancellationToken cancellationToken)

Parameters

messages
The array of messages to append to the folder.
flags
The message flags to use for each of the messages.
dates
The received dates to use for each of the messages.
cancellationToken
The cancellation token.

Returns

The UIDs of the appended messages, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Attributes Property

Gets the folder attributes.

Syntax

public FolderAttributes Attributes { get; }

Value

The folder attributes.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Check Method

Forces the server to flush its state for the folder.

Syntax

public void Check ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Check Method

Forces the server to flush its state for the folder.

Syntax

public void Check (System.Threading.CancellationToken cancellationToken)

Parameters

cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Close Method

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

Syntax

public void Close (bool expunge)

Parameters

expunge
If set to true, expunge.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Close Method

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

Syntax

public void Close (bool expunge, System.Threading.CancellationToken cancellationToken)

Parameters

expunge
If set to true, expunge.
cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

CopyTo Method

Copies the specified messages to the destination folder.

Syntax

public UniqueId[] CopyTo (UniqueId[] uids, IFolder destination)

Parameters

uids
The UIDs of the messages to copy.
destination
The destination folder.

Returns

The UIDs of the messages in the destination folder, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

CopyTo Method

Copies the specified messages to the destination folder.

Syntax

public void CopyTo (int[] indexes, IFolder destination)

Parameters

indexes
The indexes of the messages to copy.
destination
The destination folder.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

CopyTo Method

Copies the specified messages to the destination folder.

Syntax

public UniqueId[] CopyTo (UniqueId[] uids, IFolder destination, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The UIDs of the messages to copy.
destination
The destination folder.
cancellationToken
The cancellation token.

Returns

The UIDs of the messages in the destination folder, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

CopyTo Method

Copies the specified messages to the destination folder.

Syntax

public void CopyTo (int[] indexes, IFolder destination, System.Threading.CancellationToken cancellationToken)

Parameters

indexes
The indexes of the messages to copy.
destination
The destination folder.
cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Count Property

Gets the total number of messages in the folder.

Syntax

public int Count { get; }

Value

The total number of messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

CountChanged Event

Occurs when the message count changes.

Syntax

public event EventHandler<EventArgs> CountChanged

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Create Method

Creates a new subfolder with the given name.

Syntax

public IFolder Create (string name, bool isMessageFolder)

Parameters

name
The name of the folder to create.
isMessageFolder
true if the folder will be used to contain messages; otherwise false.

Returns

The created folder.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Create Method

Creates a new subfolder with the given name.

Syntax

public IFolder Create (string name, bool isMessageFolder, System.Threading.CancellationToken cancellationToken)

Parameters

name
The name of the folder to create.
isMessageFolder
true if the folder will be used to contain messages; otherwise false.
cancellationToken
The cancellation token.

Returns

The created folder.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Delete Method

Deletes the folder on the IMAP server.

Syntax

public void Delete ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Delete Method

Deletes the folder on the IMAP server.

Syntax

public void Delete (System.Threading.CancellationToken cancellationToken)

Parameters

cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Deleted Event

Occurs when the folder is deleted.

Syntax

public event EventHandler<EventArgs> Deleted

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

DirectorySeparator Property

Gets the directory separator.

Syntax

public char DirectorySeparator { get; }

Value

The directory separator.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Exists Property

Gets a value indicating whether the folder exists.

Syntax

public bool Exists { get; }

Value

true if the folder exists; otherwise, false.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Expunge Method

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

Syntax

public void Expunge ()

Remarks

An IFolder.Expunged event will be emitted for each message that is expunged.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Expunge Method

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

Syntax

public void Expunge (UniqueId[] uids)

Parameters

uids
The message uids.

Remarks

An IFolder.Expunged event will be emitted for each message that is expunged.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Expunge Method

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

Syntax

public void Expunge (System.Threading.CancellationToken cancellationToken)

Parameters

cancellationToken
The cancellation token.

Remarks

An IFolder.Expunged event will be emitted for each message that is expunged.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Expunge Method

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

Syntax

public void Expunge (UniqueId[] uids, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The message uids.
cancellationToken
The cancellation token.

Remarks

An IFolder.Expunged event will be emitted for each message that is expunged.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Expunged Event

Occurs when a message is expunged from the folder.

Syntax

public event EventHandler<MessageEventArgs> Expunged

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

Fetches the message summaries for the specified message UIDs.

Syntax

Parameters

uids
The UIDs.
items
The message summary items to fetch.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

Fetches the message summaries for the specified message indexes.

Syntax

public IEnumerable<MessageSummary> Fetch (int[] indexes, MessageSummaryItems items)

Parameters

indexes
The indexes.
items
The message summary items to fetch.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

Parameters

min
The minimum UID.
max
The maximum UID, or null to specify no upper bound.
items
The message summary items to fetch.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

Fetches the message summaries for the specified message UIDs.

Syntax

Parameters

uids
The UIDs.
items
The message summary items to fetch.
cancellationToken
The cancellation token.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

public IEnumerable<MessageSummary> Fetch (UniqueId[] uids, ulong modseq, MessageSummaryItems items)

Parameters

uids
The UIDs.
modseq
The mod-sequence value.
items
The message summary items to fetch.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

Parameters

min
The minimum index.
max
The maximum index, or -1 to specify no upper bound.
items
The message summary items to fetch.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

Fetches the message summaries for the specified message indexes.

Syntax

Parameters

indexes
The indexes.
items
The message summary items to fetch.
cancellationToken
The cancellation token.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

public IEnumerable<MessageSummary> Fetch (int[] indexes, ulong modseq, MessageSummaryItems items)

Parameters

indexes
The indexes.
modseq
The mod-sequence value.
items
The message summary items to fetch.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

Parameters

min
The minimum UID.
max
The maximum UID, or null to specify no upper bound.
items
The message summary items to fetch.
cancellationToken
The cancellation token.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

Parameters

min
The minimum UID.
max
The maximum UID.
modseq
The mod-sequence value.
items
The message summary items to fetch.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

Parameters

uids
The UIDs.
modseq
The mod-sequence value.
items
The message summary items to fetch.
cancellationToken
The cancellation token.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

Parameters

min
The minimum index.
max
The maximum index, or -1 to specify no upper bound.
items
The message summary items to fetch.
cancellationToken
The cancellation token.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

public IEnumerable<MessageSummary> Fetch (int min, int max, ulong modseq, MessageSummaryItems items)

Parameters

min
The minimum index.
max
The maximum index, or -1 to specify no upper bound.
modseq
The mod-sequence value.
items
The message summary items to fetch.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

public IEnumerable<MessageSummary> Fetch (int[] indexes, ulong modseq, MessageSummaryItems items, System.Threading.CancellationToken cancellationToken)

Parameters

indexes
The indexes.
modseq
The mod-sequence value.
items
The message summary items to fetch.
cancellationToken
The cancellation token.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

Parameters

min
The minimum UID.
max
The maximum UID.
modseq
The mod-sequence value.
items
The message summary items to fetch.
cancellationToken
The cancellation token.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Fetch Method

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

Syntax

public IEnumerable<MessageSummary> Fetch (int min, int max, ulong modseq, MessageSummaryItems items, System.Threading.CancellationToken cancellationToken)

Parameters

min
The minimum index.
max
The maximum index, or -1 to specify no upper bound.
modseq
The mod-sequence value.
items
The message summary items to fetch.
cancellationToken
The cancellation token.

Returns

An enumeration of summaries for the requested messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

FirstUnread Property

Gets the index of the first unread message in the folder.

Syntax

public int FirstUnread { get; }

Value

The index of the first unread message.

Remarks

This value will only be set after the folder has been opened.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

FullName Property

Gets the full name of the folder.

Syntax

public string FullName { get; }

Value

The full name of the folder.

Remarks

This is the equivalent of the full path of a file on a file system.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetBodyPart Method

Gets the specified body part.

Syntax

public MimeKit.MimeEntity GetBodyPart (UniqueId uid, BodyPart part, bool headersOnly)

Parameters

uid
The UID of the message.
part
The body part.
headersOnly
true if only the headers should be downloaded; otherwise, false>

Returns

The body part.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetBodyPart Method

Gets the specified body part.

Syntax

public MimeKit.MimeEntity GetBodyPart (UniqueId uid, BodyPart part, System.Threading.CancellationToken cancellationToken)

Parameters

uid
The UID of the message.
part
The body part.
cancellationToken
The cancellation token.

Returns

The body part.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetBodyPart Method

Gets the specified body part.

Syntax

public MimeKit.MimeEntity GetBodyPart (int index, BodyPart part, bool headersOnly)

Parameters

index
The index of the message.
part
The body part.
headersOnly
true if only the headers should be downloaded; otherwise, false>

Returns

The body part.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetBodyPart Method

Gets the specified body part.

Syntax

public MimeKit.MimeEntity GetBodyPart (int index, BodyPart part, System.Threading.CancellationToken cancellationToken)

Parameters

index
The index of the message.
part
The body part.
cancellationToken
The cancellation token.

Returns

The body part.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetBodyPart Method

Gets the specified body part.

Syntax

public MimeKit.MimeEntity GetBodyPart (UniqueId uid, BodyPart part, bool headersOnly, System.Threading.CancellationToken cancellationToken)

Parameters

uid
The UID of the message.
part
The body part.
headersOnly
true if only the headers should be downloaded; otherwise, false>
cancellationToken
The cancellation token.

Returns

The body part.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetBodyPart Method

Gets the specified body part.

Syntax

public MimeKit.MimeEntity GetBodyPart (int index, BodyPart part, bool headersOnly, System.Threading.CancellationToken cancellationToken)

Parameters

index
The index of the message.
part
The body part.
headersOnly
true if only the headers should be downloaded; otherwise, false>
cancellationToken
The cancellation token.

Returns

The body part.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessage Method

Gets the specified message.

Syntax

public MimeKit.MimeMessage GetMessage (UniqueId uid)

Parameters

uid
The UID of the message.

Returns

The message.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessage Method

Gets the specified message.

Syntax

public MimeKit.MimeMessage GetMessage (int index)

Parameters

index
The index of the message.

Returns

The message.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessage Method

Gets the specified message.

Syntax

public MimeKit.MimeMessage GetMessage (UniqueId uid, System.Threading.CancellationToken cancellationToken)

Parameters

uid
The UID of the message.
cancellationToken
The cancellation token.

Returns

The message.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessage Method

Gets the specified message.

Syntax

public MimeKit.MimeMessage GetMessage (int index, System.Threading.CancellationToken cancellationToken)

Parameters

index
The index of the message.
cancellationToken
The cancellation token.

Returns

The message.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetStream Method

Gets a substream of the specified message.

Syntax

public System.IO.Stream GetStream (UniqueId uid, int offset, int count)

Parameters

uid
The UID of the message.
offset
The starting offset of the first desired byte.
count
The number of bytes desired.

Returns

The stream.

Remarks

Fetches 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.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetStream Method

Gets a substream of the specified message.

Syntax

public System.IO.Stream GetStream (int index, int offset, int count)

Parameters

index
The index of the message.
offset
The starting offset of the first desired byte.
count
The number of bytes desired.

Returns

The stream.

Remarks

Fetches 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.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetStream Method

Gets a substream of the specified body part.

Syntax

public System.IO.Stream GetStream (UniqueId uid, BodyPart part, int offset, int count)

Parameters

uid
The UID of the message.
part
The desired body part.
offset
The starting offset of the first desired byte.
count
The number of bytes desired.

Returns

The stream.

Remarks

Fetches 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.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetStream Method

Gets a substream of the specified message.

Syntax

public System.IO.Stream GetStream (UniqueId uid, int offset, int count, System.Threading.CancellationToken cancellationToken)

Parameters

uid
The UID of the message.
offset
The starting offset of the first desired byte.
count
The number of bytes desired.
cancellationToken
The cancellation token.

Returns

The stream.

Remarks

Fetches 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.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetStream Method

Gets a substream of the specified body part.

Syntax

public System.IO.Stream GetStream (int index, BodyPart part, int offset, int count)

Parameters

index
The index of the message.
part
The desired body part.
offset
The starting offset of the first desired byte.
count
The number of bytes desired.

Returns

The stream.

Remarks

Fetches 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.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetStream Method

Gets a substream of the specified message.

Syntax

public System.IO.Stream GetStream (int index, int offset, int count, System.Threading.CancellationToken cancellationToken)

Parameters

index
The index of the message.
offset
The starting offset of the first desired byte.
count
The number of bytes desired.
cancellationToken
The cancellation token.

Returns

The stream.

Remarks

Fetches 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.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetStream Method

Gets a substream of the specified body part.

Syntax

public System.IO.Stream GetStream (UniqueId uid, BodyPart part, int offset, int count, System.Threading.CancellationToken cancellationToken)

Parameters

uid
The UID of the message.
part
The desired body part.
offset
The starting offset of the first desired byte.
count
The number of bytes desired.
cancellationToken
The cancellation token.

Returns

The stream.

Remarks

Fetches 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.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetStream Method

Gets a substream of the specified body part.

Syntax

public System.IO.Stream GetStream (int index, BodyPart part, int offset, int count, System.Threading.CancellationToken cancellationToken)

Parameters

index
The index of the message.
part
The desired body part.
offset
The starting offset of the first desired byte.
count
The number of bytes desired.
cancellationToken
The cancellation token.

Returns

The stream.

Remarks

Fetches 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.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetSubfolder Method

Gets the specified subfolder.

Syntax

public IFolder GetSubfolder (string name)

Parameters

name
The name of the subfolder.

Returns

The subfolder.

Exceptions

Type Reason
MailKit.FolderNotFoundException The requested folder could not be found.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetSubfolder Method

Gets the specified subfolder.

Syntax

public IFolder GetSubfolder (string name, System.Threading.CancellationToken cancellationToken)

Parameters

name
The name of the subfolder.
cancellationToken
The cancellation token.

Returns

The subfolder.

Exceptions

Type Reason
MailKit.FolderNotFoundException The requested folder could not be found.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetSubfolders Method

Gets the subfolders.

Syntax

public IEnumerable<IFolder> GetSubfolders (bool subscribedOnly)

Parameters

subscribedOnly
If set to true, only subscribed folders will be listed.

Returns

The subfolders.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetSubfolders Method

Gets the subfolders.

Syntax

public IEnumerable<IFolder> GetSubfolders (bool subscribedOnly, System.Threading.CancellationToken cancellationToken)

Parameters

subscribedOnly
If set to true, only subscribed folders will be listed.
cancellationToken
The cancellation token.

Returns

The subfolders.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

HighestModSeq Property

Gets the highest mod-sequence value of all messages in the mailbox.

Syntax

public ulong HighestModSeq { get; }

Value

The highest mod-sequence value.

Remarks

This property is only available if the IMAP server supports the CONDSTORE extension.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

IsNamespace Property

Gets whether or not the folder is a namespace folder.

Syntax

public bool IsNamespace { get; }

Value

true if the folder is a namespace folder; otherwise, false.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

IsOpen Property

Gets a value indicating whether the folder is currently open.

Syntax

public bool IsOpen { get; }

Value

true if the folder is currently open; otherwise, false.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

IsSubscribed Property

Gets a value indicating whether the folder is subscribed.

Syntax

public bool IsSubscribed { get; }

Value

true if the folder is subscribed; otherwise, false.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

MessageFlagsChanged Event

Occurs when flags changed on a message.

Syntax

public event EventHandler<MessageFlagsChangedEventArgs> MessageFlagsChanged

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

MoveTo Method

Moves the specified messages to the destination folder.

Syntax

public UniqueId[] MoveTo (UniqueId[] uids, IFolder destination)

Parameters

uids
The UIDs of the messages to copy.
destination
The destination folder.

Returns

The UIDs of the messages in the destination folder, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

MoveTo Method

Moves the specified messages to the destination folder.

Syntax

public void MoveTo (int[] indexes, IFolder destination)

Parameters

indexes
The indexes of the messages to copy.
destination
The destination folder.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

MoveTo Method

Moves the specified messages to the destination folder.

Syntax

public UniqueId[] MoveTo (UniqueId[] uids, IFolder destination, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The UIDs of the messages to copy.
destination
The destination folder.
cancellationToken
The cancellation token.

Returns

The UIDs of the messages in the destination folder, if available; otherwise, null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

MoveTo Method

Moves the specified messages to the destination folder.

Syntax

public void MoveTo (int[] indexes, IFolder destination, System.Threading.CancellationToken cancellationToken)

Parameters

indexes
The indexes of the messages to copy.
destination
The destination folder.
cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Name Property

Gets the name of the folder.

Syntax

public string Name { get; }

Value

The name of the folder.

Remarks

This is the equivalent of the file name of a file on the file system.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Open Method

Opens the folder using the requested folder access.

Syntax

public FolderAccess Open (FolderAccess access)

Parameters

access
The requested folder access.

Returns

The MailKit.FolderAccess state of the folder.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Open Method

Opens the folder using the requested folder access.

Syntax

public FolderAccess Open (FolderAccess access, System.Threading.CancellationToken cancellationToken)

Parameters

access
The requested folder access.
cancellationToken
The cancellation token.

Returns

The MailKit.FolderAccess state of the folder.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

ParentFolder Property

Gets the parent folder.

Syntax

public IFolder ParentFolder { get; }

Value

The parent folder.

Remarks

Root-level folders do not have a parent folder.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

PermanentFlags Property

Gets the permanent flags.

Syntax

public MessageFlags PermanentFlags { get; }

Value

The permanent flags.

Remarks

The permanent flags are the message flags that will persist between sessions.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Recent Property

Gets the number of recently added messages.

Syntax

public int Recent { get; }

Value

The number of recently added messages.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

RecentChanged Event

Occurs when the recent message count changes.

Syntax

public event EventHandler<EventArgs> RecentChanged

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

RemoveFlags Method

Removes a set of flags from the specified messages.

Syntax

public void RemoveFlags (UniqueId[] uids, MessageFlags flags, bool silent)

Parameters

uids
The UIDs of the messages.
flags
The message flags to remove.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

RemoveFlags Method

Removes a set of flags from the specified messages.

Syntax

public void RemoveFlags (int[] indexes, MessageFlags flags, bool silent)

Parameters

indexes
The indexes of the messages.
flags
The message flags to remove.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

RemoveFlags Method

Removes a set of flags from the specified messages.

Syntax

public void RemoveFlags (UniqueId[] uids, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The UIDs of the messages.
flags
The message flags to remove.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

RemoveFlags Method

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

Syntax

public UniqueId[] RemoveFlags (UniqueId[] uids, ulong modseq, MessageFlags flags, bool silent)

Parameters

uids
The UIDs of the messages.
modseq
The mod-sequence value.
flags
The message flags to remove.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Returns

The unique IDs of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

RemoveFlags Method

Removes a set of flags from the specified messages.

Syntax

public void RemoveFlags (int[] indexes, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

indexes
The indexes of the messages.
flags
The message flags to remove.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

RemoveFlags Method

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

Syntax

public int[] RemoveFlags (int[] indexes, ulong modseq, MessageFlags flags, bool silent)

Parameters

indexes
The indexes of the messages.
modseq
The mod-sequence value.
flags
The message flags to remove.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Returns

The indexes of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

RemoveFlags Method

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

Syntax

public UniqueId[] RemoveFlags (UniqueId[] uids, ulong modseq, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The UIDs of the messages.
modseq
The mod-sequence value.
flags
The message flags to remove.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Returns

The unique IDs of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

RemoveFlags Method

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

Syntax

public int[] RemoveFlags (int[] indexes, ulong modseq, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

indexes
The indexes of the messages.
modseq
The mod-sequence value.
flags
The message flags to remove.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Returns

The indexes of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Rename Method

Renames the folder to exist with a new name under a new parent folder.

Syntax

public void Rename (IFolder parent, string name)

Parameters

parent
The new parent folder.
name
The new name of the folder.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Rename Method

Renames the folder to exist with a new name under a new parent folder.

Syntax

public void Rename (IFolder parent, string name, System.Threading.CancellationToken cancellationToken)

Parameters

parent
The new parent folder.
name
The new name of the folder.
cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Renamed Event

Occurs when the folder is renamed.

Syntax

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Search Method

Searches the folder for messages matching the specified query.

Syntax

public UniqueId[] Search (MailKit.Search.SearchQuery query)

Parameters

query
The search query.

Returns

An array of matching UIDs.

Remarks

The returned array of unique identifiers can be used with IFolder.GetMessage(UniqueId, System.Threading.CancellationToken).

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Search Method

Searches the folder for messages matching the specified query, returning them in the preferred sort order.

Syntax

Parameters

query
The search query.
orderBy
The sort order.

Returns

An array of matching UIDs in the specified sort order.

Remarks

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

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Search Method

Searches the folder for messages matching the specified query.

Syntax

Parameters

query
The search query.
cancellationToken
The cancellation token.

Returns

An array of matching UIDs.

Remarks

The returned array of unique identifiers can be used with IFolder.GetMessage(UniqueId, System.Threading.CancellationToken).

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Search Method

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

Syntax

public UniqueId[] Search (UniqueId[] uids, MailKit.Search.SearchQuery query)

Parameters

uids
The subset of UIDs
query
The search query.

Returns

An array of matching UIDs.

Remarks

The returned array of unique identifiers can be used with IFolder.GetMessage(UniqueId, System.Threading.CancellationToken).

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Search Method

Searches the folder for messages matching the specified query, returning them in the preferred sort order.

Syntax

Parameters

query
The search query.
orderBy
The sort order.
cancellationToken
The cancellation token.

Returns

An array of matching UIDs in the specified sort order.

Remarks

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

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Search Method

Searches the subset of UIDs in the folder for messages matching the specified query, returning them in the preferred sort order.

Syntax

public UniqueId[] Search (UniqueId[] uids, MailKit.Search.SearchQuery query, MailKit.Search.OrderBy[] orderBy)

Parameters

uids
The subset of UIDs
query
The search query.
orderBy
The sort order.

Returns

An array of matching UIDs in the specified sort order.

Remarks

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

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Search Method

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

Syntax

public UniqueId[] Search (UniqueId[] uids, MailKit.Search.SearchQuery query, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The subset of UIDs
query
The search query.
cancellationToken
The cancellation token.

Returns

An array of matching UIDs.

Remarks

The returned array of unique identifiers can be used with IFolder.GetMessage(UniqueId, System.Threading.CancellationToken).

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Search Method

Searches the subset of UIDs in the folder for messages matching the specified query, returning them in the preferred sort order.

Syntax

public UniqueId[] Search (UniqueId[] uids, MailKit.Search.SearchQuery query, MailKit.Search.OrderBy[] orderBy, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The subset of UIDs
query
The search query.
orderBy
The sort order.
cancellationToken
The cancellation token.

Returns

An array of matching UIDs in the specified sort order.

Remarks

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

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

SetFlags Method

Sets the flags of the specified messages.

Syntax

public void SetFlags (UniqueId[] uids, MessageFlags flags, bool silent)

Parameters

uids
The UIDs of the messages.
flags
The message flags to set.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

SetFlags Method

Sets the flags of the specified messages.

Syntax

public void SetFlags (int[] indexes, MessageFlags flags, bool silent)

Parameters

indexes
The indexes of the messages.
flags
The message flags to set.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

SetFlags Method

Sets the flags of the specified messages.

Syntax

public void SetFlags (UniqueId[] uids, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The UIDs of the messages.
flags
The message flags to set.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

SetFlags Method

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

Syntax

public UniqueId[] SetFlags (UniqueId[] uids, ulong modseq, MessageFlags flags, bool silent)

Parameters

uids
The UIDs of the messages.
modseq
The mod-sequence value.
flags
The message flags to set.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Returns

The unique IDs of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

SetFlags Method

Sets the flags of the specified messages.

Syntax

public void SetFlags (int[] indexes, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

indexes
The indexes of the messages.
flags
The message flags to set.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

SetFlags Method

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

Syntax

public int[] SetFlags (int[] indexes, ulong modseq, MessageFlags flags, bool silent)

Parameters

indexes
The indexes of the messages.
modseq
The mod-sequence value.
flags
The message flags to set.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.

Returns

The indexes of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

SetFlags Method

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

Syntax

public UniqueId[] SetFlags (UniqueId[] uids, ulong modseq, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The UIDs of the messages.
modseq
The mod-sequence value.
flags
The message flags to set.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Returns

The unique IDs of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

SetFlags Method

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

Syntax

public int[] SetFlags (int[] indexes, ulong modseq, MessageFlags flags, bool silent, System.Threading.CancellationToken cancellationToken)

Parameters

indexes
The indexes of the messages.
modseq
The mod-sequence value.
flags
The message flags to set.
silent
If set to true, no IFolder.MessageFlagsChanged events will be emitted.
cancellationToken
The cancellation token.

Returns

The indexes of the messages that were not updated.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Status Method

Updates the values of the specified items.

Syntax

public void Status (StatusItems items)

Parameters

items
The items to update.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Status Method

Updates the values of the specified items.

Syntax

public void Status (StatusItems items, System.Threading.CancellationToken cancellationToken)

Parameters

items
The items to update.
cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Subscribe Method

Subscribes the folder.

Syntax

public void Subscribe ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Subscribe Method

Subscribes the folder.

Syntax

public void Subscribe (System.Threading.CancellationToken cancellationToken)

Parameters

cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Subscribed Event

Occurs when the folder is subscribed.

Syntax

public event EventHandler<EventArgs> Subscribed

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

SupportsModSeq Property

Gets whether or not the folder supports mod-sequences.

Syntax

public bool SupportsModSeq { get; }

Value

true if supports mod-sequences; otherwise, false.

Remarks

If mod-sequences are not supported by the folder, then all of the APIs that take a modseq argument will throw NotSupportedException and should not be used.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Thread Method

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

Syntax

Parameters

algorithm
The threading algorithm to use.
query
The search query.

Returns

An array of message threads.

Remarks

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Thread Method

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

Syntax

Parameters

algorithm
The threading algorithm to use.
query
The search query.
cancellationToken
The cancellation token.

Returns

An array of message threads.

Remarks

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Thread Method

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

Syntax

public MessageThread[] Thread (UniqueId[] uids, ThreadingAlgorithm algorithm, MailKit.Search.SearchQuery query)

Parameters

uids
The subset of UIDs
algorithm
The threading algorithm to use.
query
The search query.

Returns

An array of message threads.

Remarks

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Thread Method

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

Syntax

public MessageThread[] Thread (UniqueId[] uids, ThreadingAlgorithm algorithm, MailKit.Search.SearchQuery query, System.Threading.CancellationToken cancellationToken)

Parameters

uids
The subset of UIDs
algorithm
The threading algorithm to use.
query
The search query.
cancellationToken
The cancellation token.

Returns

An array of message threads.

Remarks

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

UidNext Property

Gets the UID that the next message that is added to the folder will be assigned.

Syntax

public Nullable<UniqueId> UidNext { get; }

Value

The next UID.

Remarks

This value will only be set after the folder has been opened.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

UidValidity Property

Gets the Unique ID validity.

Syntax

public Nullable<UniqueId> UidValidity { get; }

Value

The UID validity.

Remarks

UIDs are only valid so long as the UID validity value remains unchanged. If and when the folder's IFolder.UidValidity is changed, a client MUST discard its cache of UIDs along with any summary information that it may have and re-query the folder.

The IFolder.UidValidity will only be set after the folder has been opened.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

UidValidityChanged Event

Occurs when the UID validity changes.

Syntax

public event EventHandler<EventArgs> UidValidityChanged

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Unsubscribe Method

Unsubscribes the folder.

Syntax

public void Unsubscribe ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Unsubscribe Method

Unsubscribes the folder.

Syntax

public void Unsubscribe (System.Threading.CancellationToken cancellationToken)

Parameters

cancellationToken
The cancellation token.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Unsubscribed Event

Occurs when the folder is unsubscribed.

Syntax

public event EventHandler<EventArgs> Unsubscribed

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0