Begins asynchronous Purge operation. Permanently removes all messages marked as deleted (with a Deleted flag) from the current folder.

Namespace:  Rebex.Net
Assembly:  Rebex.Imap (in Rebex.Imap.dll)

Syntax

Visual Basic
Public Function BeginPurge ( _
	messageSet As ImapMessageSet, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginPurge(
	ImapMessageSet messageSet,
	AsyncCallback callback,
	Object state
)

Parameters

messageSet
Type: Rebex.Net..::..ImapMessageSet
Message set comprised of message unique IDs to purge. Only supported by servers that support the UIDPLUS extension. Only the messages that are both present in the set and also have the Deleted flag set will be purged.
callback
Type: System..::..AsyncCallback
An optional asynchronous callback to be called when the operation is complete.
state
Type: System..::..Object
A user-provided object that identifies this particular asynchronous operation.

Return Value

An IAsyncResult that references the asynchronous operation.

Remarks

This method represents IMAP EXPUNGE command.

This message set may be specified to ensure that the method does not remove any messages that have been marked as Deleted between the time that the user requested the purge operation and the time the server processes the command.

In builds for .NET 4.0 and higher, this method is available as an extension method. Add 'using Rebex.Legacy' (C#) or 'Import Rebex.Legacy' (VB.NET) to your code in order to use it.

Version Information

.NET Compact Framework

Supported in: 3.9, 3.5

See Also