C Style API
bbGetCustomHeader() Function

Returns the value of a custom email header within the sMessageText parameter.

bbGetCustomHeader (sMessageText, sReturn, lLength, sCustomHeader)



Parameters

sMessageText

Null terminated character array containing the email message that you need to retrieve the custom header value from.

sReturn [out]

Null terminated 255 character array. Returns the content of the custom header.

lLength [out]

Returns a long value. Contains the length of the value returned in sReturn.

sCustomHeader

Null terminated character array. Specifies the custom header you want to retrieve.


Syntax - (Visual Basic)

' ** Pad sValue out parameter with spaces.
sValue = String(255, " ")

' ** Call Subroutine: Retrieve "Date:" header.
Call bbGetCustomHeader(sMessage, sValue, lLength, "Date")

' ** Set value
sCustom = Left(sValue, lLength)


Remarks

For more examples, and language specific declarations, see sample source code files that came with BoogieBounce API.


See Also

Visual Basic Users
Power Basic Users