Click or drag to resize
MimeKit

ImapFolderReplace(FormatOptions, Int32, IReplaceRequest, CancellationToken) Method

Replace a message in the folder.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
public override UniqueId? Replace(
	FormatOptions options,
	int index,
	IReplaceRequest request,
	CancellationToken cancellationToken = default
)

Parameters

options  FormatOptions
The formatting options.
index  Int32
The index of the message to be replaced.
request  IReplaceRequest
The replace request.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

NullableUniqueId
The UID of the new message, if available; otherwise, null.

Implements

IMailFolderReplace(FormatOptions, Int32, IReplaceRequest, CancellationToken)
IMailFolderReplace(FormatOptions, Int32, IReplaceRequest, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullException

options is null.

-or-

request is null.

ArgumentOutOfRangeExceptionindex is out of range.
ArgumentException The destination folder does not belong to this ImapClient.
ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
ServiceNotAuthenticatedException The ImapClient is not authenticated.
InvalidOperationException Internationalized formatting was requested but has not been enabled.
FolderNotFoundException The ImapFolder does not exist.
FolderNotOpenException The ImapFolder is not currently open in read-write mode.
OperationCanceledException The operation was canceled via the cancellation token.
NotSupportedException

Internationalized formatting was requested but is not supported by the server.

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
Replaces a message in the folder and returns the UniqueId assigned to the new message.
See Also