PureBasic

Get a Header Field by Name

Demonstrates the Chilkat Email.GetHeaderField method, which returns the value of a header field by name. Header-field names are case-insensitive, so X-Priority and x-priority refer to the same field. This example reads several headers by name.

Background: Looking up a header by name is the quickest way to read a known field like Subject or a custom X- header. One caveat: some header names (such as Received) can legitimately appear more than once. When a field may repeat and you need every occurrence, enumerate by index with GetHeaderFieldName and GetHeaderFieldValue instead of looking up by name.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkEmail.pb"

Procedure ChilkatExample()

    ;  Demonstrates the GetHeaderField method, which returns the value of a header field by
    ;  name.  Header-field names are case-insensitive.

    email.i = CkEmail::ckCreate()
    If email.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkEmail::setCkSubject(email, "Quarterly report")
    CkEmail::setCkFrom(email, "alice@example.com")
    CkEmail::ckAddHeaderField(email,"X-Priority","1")

    ;  Get header field values by name.
    Debug "Subject = " + CkEmail::ckGetHeaderField(email,"Subject")
    Debug "From = " + CkEmail::ckGetHeaderField(email,"From")
    Debug "X-Priority = " + CkEmail::ckGetHeaderField(email,"x-priority")


    CkEmail::ckDispose(email)


    ProcedureReturn
EndProcedure