Downloads the specified part of the message with the specified unique ID and writes its data into a supplied stream.

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

Syntax

Visual Basic
Public Function GetMessage ( _
	uniqueId As String, _
	output As Stream, _
	remoteOffset As Long, _
	length As Integer _
) As Long
C#
public long GetMessage(
	string uniqueId,
	Stream output,
	long remoteOffset,
	int length
)

Parameters

uniqueId
Type: System..::..String
Message unique ID.
output
Type: System.IO..::..Stream
Stream that will receive the message.
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.

Return Value

The length of the message in bytes.

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.

Version Information

.NET Compact Framework

Supported in: 3.9, 3.5

See Also