|
Summary
Start message extraction.
Syntax
| Boolean ExtractMessageStart (Destination) |
Description
To extract a message the ExtractMessageStart method must be called, then the
ExtractMessageData must be called to pass the message to be extracted to the control. When
all the data has been passed to the control the ExtractMessageEnd method must be called to
signal the MIME ActiveX control to begin the extraction process. Once the
ExtractMessageEnd method has been called the extracted message and any attachments are
delivered to the application in one or more OnRecvAddrField, OnRecvHeader and OnRecvBody
(or OnRecvBodyB) events. This method separates the actual message from its attachments.
The Destination parameter must be set to the destination directory name for the
message body and attachments to be extracted to. The Destination parameter should
be set to an empty string if the application wants to receive the actual message body and
attachment in the events instead of having them saved to files.
The OnRecvAddrField event is fired two or more times to deliver the address fields to
the application. The MIME ActiveX control then extracts the message header and body, and
fires the OnRecvHeader event to deliver the message header and the OnRecvBody event (or
OnRecvBodyB event if the UseVariant property is set to True) to deliver the message body.
If the Destination directory is set to NULL then the control will deliver the actual body
of the message in the OnRecvBody event, otherwise it will save the body to the Destination
directory and deliver the name of the file in the OnRecvBody event. Any attachments are
delivered to the application in the same way.
For Partial messages, the OnRecvHeader event will be fired only when all the parts of
the message have been extracted and reassembled. An OnError event will occur to indicate
only a part of the message has been extracted.
If an error occurs, then the OnError event will be fired. The application may want to
display an error message in the OnError event to inform the user of the error. Please
check the reference page of the OnError event for a complete listing of error codes.
Return Value
This method returns True if it is successful and False if it
fails. The application should check the return value to determine if the method was
successful.
Example
Result = Mime.ExtractMessageStart ("c:\temp\")
If Result = True Then
MsgBox "Extracted message started successfully", 64, "Sample Program"
End If
| 
