Click or drag to resize
MimeKit

MailSpoolGetMessageUid Method

Get the UID of the message at the specified index.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.12.1
Syntax
C#
Copy
public abstract string GetMessageUid(
	int index,
	CancellationToken cancellationToken = default
)

Parameters

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

Return Value

String
The message UID.

Implements

IMailSpoolGetMessageUid(Int32, CancellationToken)
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionindex 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.
Remarks
Not all servers support UIDs, so you should first check the SupportsUids property.
See Also