MailSpoolGetMessageUidAsync Method

Asynchronously get the UID of the message at the specified index.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public abstract Task<string> GetMessageUidAsync(
	int index,
	CancellationToken cancellationToken = default
)

Parameters

index  Int32
The message index.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskString
The message UID.

Implements

IMailSpoolGetMessageUidAsync(Int32, CancellationToken)

Remarks

Not all servers support UIDs, so you should first check the SupportsUids property.

Exceptions

ArgumentOutOfRangeException index is not a valid message index.
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.

See Also