ComponentPro UltimateMail

DownloadMessage(Int32, String) Method

Class Reference > ComponentPro.Net.Mail Namespace > Imap Class > DownloadMessage(Int32, String) Method

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

Syntax

public long DownloadMessage(
   int messageInboxIndex, 
   string fileName
)

Public Function DownloadMessage( _
   ByVal messageInboxIndex As Integer,  _
   ByVal fileName As String _
) As Long

public:
  long DownloadMessage(
   int messageInboxIndex, 
   String^ fileName
);

Parameters

messageInboxIndex: Message sequence number.
fileName: The path of the local file. This cannot be a directory.

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 DontMarkAsSeen to true.

Framework

.NET Compact Framework

Supported version: 2.0, 3.5, and 3.9
Assembly: ComponentPro.Mail.CF (in ComponentPro.Mail.CF.dll)

.NET Framework

Supported version: 2.0, 3.0, 3.5, 4.0, 4.5.x, 4.6.x and later
Assembly: ComponentPro.Mail (in ComponentPro.Mail.dll)

Xamarin Android

Supported version: 2.3 and later
Assembly: ComponentPro.Mail.Android (in ComponentPro.Mail.Android.dll)

Xamarin Mac

Supported version: 2.0.x and later
Assembly: ComponentPro.Mail.Mac (in ComponentPro.Mail.Mac.dll)

Xamarin iOS

Supported version: 5.1.x and later
Assembly: ComponentPro.Mail.iOS (in ComponentPro.Mail.iOS.dll)