IMailFolderExtensionsAppend(IMailFolder, FormatOptions, IListMimeMessage, IListMessageFlags, CancellationToken, ITransferProgress) Method

Append the specified messages to the folder.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public static IList<UniqueId> Append(
	this IMailFolder folder,
	FormatOptions options,
	IList<MimeMessage> messages,
	IList<MessageFlags> flags,
	CancellationToken cancellationToken = default,
	ITransferProgress? progress = null
)

Parameters

folder  IMailFolder
The folder.
options  FormatOptions
The formatting options.
messages  IListMimeMessage
The array of messages to append to the folder.
flags  IListMessageFlags
The message flags to use for each message.
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

IListUniqueId
The UIDs of the appended messages, if available; otherwise an empty array.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMailFolder. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.

Exceptions

ArgumentNullException

options is .

-or-

messages is .

-or-

flags is .
ArgumentException

One or more of the messages is null.

-or-

The number of messages does not match the number of flags.
ObjectDisposedException The IMailStore has been disposed.
ServiceNotConnectedException The IMailStore is not connected.
ServiceNotAuthenticatedException The IMailStore is not authenticated.
FolderNotFoundException The MailFolder does not exist.
InvalidOperationException Internationalized formatting was requested but has not been enabled.
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.
ProtocolException The server's response contained unexpected tokens.
CommandException The command failed.

See Also