:GetHeaderValue()
Class
Syntax
:GetHeaderValue( nMsg, cHeader, [hSession] ) -> cValue
Parameters
|
|
nMsgNo |
Message number to get cHeader for. |
|
|
cHeader |
Message Header to get the value for. |
|
|
hSession |
Optional: If hSession is not passed, the value in :Session will be used |
Return
Returns the value of the Header, cHeader.
If cHeader is not available in the message or an error occurred, an empty string is returned.
To get more information about the error, see :nErr and :cErr.
Description
The PopGetHeaderValue function returns the value of a header field in the specified message.
The PopGetHeaderValue function returns the value of a header field from the specified message. This allows an application to be able to easily determine the value of a header (such as the sender, or the subject of the message) without downloading the entire header block or contents of the message.
This function uses the XTND XLST command, which is an extension to the POP3 protocol. Not all servers support the use of this command. If the command is not supported, the function will return an error.
See Also
:GetMessageHeader(), :GetMessageID(), :GetMessageSender()