Click or drag to resize
MimeKit

MailSpoolGetMessageUidsAsync Method

Get the full list of available message UIDs.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
Copy
public abstract Task<IList<string>> GetMessageUidsAsync(
	CancellationToken cancellationToken = default
)

Parameters

cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskIListString
The message uids.

Implements

IMailSpoolGetMessageUidsAsync(CancellationToken)
Exceptions
ExceptionCondition
ObjectDisposedException The MailSpool has been disposed.
ServiceNotConnectedException The MailSpool is not connected.
ServiceNotAuthenticatedException The MailSpool is not authenticated.
NotSupportedException The mail spool does not support UIDs.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
CommandException The command failed.
ProtocolException A protocol error occurred.
Remarks
Not all servers support UIDs, so you should first check the SupportsUids property.
See Also