Downloads the message with the specified sequence number and writes its data into a local file.

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

Syntax

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

Parameters

sequenceNumber
Type: System..::..Int32
Message sequence number.
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.

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