:GetMessageHeader()
Class
Syntax
:GetMessageHeader( cHeader, [hMessage] ) -> cHeaderString
Parameters
|
|
cHeader |
Message Header to get the value for. |
|
|
hMessage |
Optional. Handle of the message to act on. Provided during :CreateMessage() operation |
Return
If the function succeeds, the return value is the current value for the Message Header field cHeader.
If the function fails, the return value is an emptry string ("").
To get extended error information, see :nErr and :cErr.
Description
The :GetMessageHeader() method returns the current message Header string for the specified message.
Each part in a multipart message has one or more header fields. To obtain header values for the main message, rather than the message attachments, the current part number must be set to zero using the :SetMessagePart() method.
See Also
:CreateMessagePart(), :DeleteMessagePart(), :GetMessagePartCount(), :SetMessagePart(), :GetMessagePart(), EnumMessageHeaders(), GetFirstHeader(), :GetNextHeader(), :ParseHeader(), :SetMessageHeader()