Click or drag to resize
MimeKit

Pop3ClientGetMessageUidAsync Method

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

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 4.12.1
Syntax
C#
Copy
public override 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)
IMailSpoolGetMessageUidAsync(Int32, CancellationToken)
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionindex is not a valid message index.
ObjectDisposedException The Pop3Client has been disposed.
ServiceNotConnectedException The Pop3Client is not connected.
ServiceNotAuthenticatedException The Pop3Client is not authenticated.
NotSupportedException The POP3 server does not support the UIDL extension.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
Pop3CommandException The POP3 command failed.
Pop3ProtocolException A POP3 protocol error occurred.
Remarks

Gets the UID of the message at the specified index.

Caution note  Caution
Not all servers support UIDs, so you should first check the Capabilities property for the UIDL flag or the SupportsUids convenience property.
See Also