InternetMail.StoreMessage Method (String)

Retrieve the current message and store it in a file on the local system.

Parameters

fileName

A string which specifies the file that the message will be stored in. If the file does not exist, it will be created. If the file does exist, it will be overwritten with the contents of the message.

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 StoreMessage method retrieves the current message from the server and stores it in a file on the local system. The contents of the message is stored as a text file, using the specified file name. 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.

See Also

InternetMail Class | SocketTools Namespace | InternetMail.StoreMessage Overload List