InternetMail.GetMessage Method (String)

Retrieve the current message from the server and return the contents in a string.

[Visual Basic]
Overloads Public Function GetMessage( _
ByRef buffer As String _
) As Boolean

[C#]
public bool GetMessage(
ref string buffer
);

Parameters

buffer: A string passed by reference that will contain the message data when the method returns.

Return Value

This method returns a boolean value. If the method succeeds, the return value is true. If the method fails, the return value is false. To get extended error information, check the value of the LastError property.

Remarks

The GetMessage method is used to retrieve the current message from the server and copy it into a local buffer. This method will cause the current thread to block until the message transfer completes, a timeout occurs or the transfer is canceled. During the transfer, the OnProgress event will fire periodically, enabling the application to update any user interface objects such as a progress bar.

The current message number is specified by the value of the Message property.

InternetMail.GetMessage Method (String)

Parameters

Return Value

Remarks

See Also