Begins asynchronous GetMessage operation. Downloads the message with the specified unique ID and writes its data into a local file.

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

Syntax

Visual Basic
Public Function BeginGetMessage ( _
	uniqueId As String, _
	fileName As String, _
	remoteOffset As Long, _
	length As Integer, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginGetMessage(
	string uniqueId,
	string fileName,
	long remoteOffset,
	int length,
	AsyncCallback callback,
	Object state
)

Parameters

uniqueId
Type: System..::..String
Message unique ID.
fileName
Type: System..::..String
The path of the local file. This cannot be a directory.
remoteOffset
Type: System..::..Int64
The starting offset of the message data to download.
length
Type: System..::..Int32
Number of bytes to transfer or -1 to transfer all data until an end of message is reached.
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