|
Summary
Create message.
Syntax
| Boolean CreateMessage (Destination, IsMime, IsNews) |
| |
Destination |
String |
| |
IsMime |
Boolean |
| |
IsNews |
Boolean |
Description
To create a message, call the CreateMessage method with the parameters set as described
below. The Destination parameter must be set to the destination file name for the
created message, or an empty string. If the Destination parameter is set to an
empty string the OnData (or OnDataB if the UseVariant property is set to True) event will
be fired one or more times to deliver the entire created message. The IsMime
parameter specifies whether the message to be created is a MIME message (True or 1) or a
non-MIME message (False or 0). The IsNews parameter specifies whether the message
to be created is a mail message (False or 0) or a news article (True or 1).
Before a message is created the To, From, Cc (optional), Bcc (optional) and Subject
(optional) fields need to be set. The OnSetAddrField event is fired repeatedly to get the
address fields. The To and From address fields are compulsary and must be set using this
event.
The OnSetHeader and OnSetBody (or the OnSetBodyB event if UseVariant is True) events
will be fired to obtain the message header information and body, as well as any
attachments. The message properties should be set in the OnSetHeader event(s). The message
body or filename should be set in the OnSetBody (or OnSetBodyB if the UseVariant property
is True) event. The UseVariant property is used to specify whether the data should be sent
as binary data or not, if UseVariant is True then the data will be treated as binary data.
For partial messages, the OnPartial event will be fired to obtain the part number and id
and for external messages, the OnExternal event will be fired to obtain the access type
and other pertaining information.
Plain messages can be plain text or uuencoded. MIME messages can be base64 encoded,
quoted-printable encoded, binhex encoded or plain text. The encoding is done by the MIME
ActiveX control and the Encoding property should be set in the OnSetHeader event, the
Charset, FileDesc, FileName and FileSize properties are optional. The FileDesc and
FileName values may be encoded, to encode these value use the EncodeHdrField method, and
to decode them use the DecodeHdrField method.
For MIME messages the ContentType, and Subtype properties have to be set in the
OnSetHeader event. (The FileName, ContentId properties are optional.) The ContentLocation,
ContentBase, MultipartStart and MultipartType properties are optional and only relevant
for MIME Message\Related messages. The BinHexFlag, BinHexType, BinHexCreator properties
are optional and relevant only for MIME messages that have the Encoding property of
"binhex". The MessageType property must be set for partial or external MIME
messages.
Please check the reference page of the individual properties for more information.
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
The CreateMessage method returns True if successful; otherwise it will False. The
application should check the return value so that it can determine if the method was
successful. .
Example
Result = Mime.CreateMessage ("c:\temp\test", True, False)
If Result = True Then
MsgBox "Created message successfully", 64, "Sample Program"
End If
| 
