Click or drag to resize
MimeKit

ImapFolderOpen Method (FolderAccess, UInt32, UInt64, IListUniqueId, CancellationToken)

Open the folder using the requested folder access.

Namespace:  MailKit.Net.Imap
Assembly:  MailKit (in MailKit.dll) Version: 2.14.0
Syntax
C#
public override FolderAccess Open(
	FolderAccess access,
	uint uidValidity,
	ulong highestModSeq,
	IList<UniqueId> uids,
	CancellationToken cancellationToken = default
)

Parameters

access
Type: MailKitFolderAccess
The requested folder access.
uidValidity
Type: SystemUInt32
The last known UidValidity value.
highestModSeq
Type: SystemUInt64
The last known HighestModSeq value.
uids
Type: System.Collections.GenericIListUniqueId
The last known list of unique message identifiers.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: FolderAccess
The FolderAccess state of the folder.

Implements

IMailFolderOpen(FolderAccess, UInt32, UInt64, IListUniqueId, CancellationToken)
IMailFolderOpen(FolderAccess, UInt32, UInt64, IListUniqueId, CancellationToken)
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionaccess is not a valid value.
ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
ServiceNotAuthenticatedException The ImapClient is not authenticated.
FolderNotFoundException The ImapFolder does not exist.
InvalidOperationException The QRESYNC feature has not been enabled.
NotSupportedException The IMAP server does not support the QRESYNC extension.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
ImapProtocolException The server's response contained unexpected tokens.
ImapCommandException The server replied with a NO or BAD response.
Remarks

This variant of the Open(FolderAccess, CancellationToken) method is meant for quick resynchronization of the folder. Before calling this method, the 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.

See Also