Begins asynchronous GetMessage operation. Downloads the message with the specified sequence number and writes its data into a supplied stream.

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

Syntax

Visual Basic
Public Function BeginGetMessage ( _
	sequenceNumber As Integer, _
	output As Stream, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginGetMessage(
	int sequenceNumber,
	Stream output,
	AsyncCallback callback,
	Object state
)

Parameters

sequenceNumber
Type: System..::..Int32
Message sequence number.
output
Type: System.IO..::..Stream
Stream that will receive the message.
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

Uses IMAP FETCH command to retrieve the message.

By default, this method marks the message as read. To prevent this behavior, set the UsePeekForGetMessage to true.

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