Get a Header Field by Name

See more Email Object Examples

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 C Downloads

Download Chilkat for C

#include <C_CkEmail.h>

void ChilkatSample(void)
    {
    HCkEmail email;

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

    email = CkEmail_Create();
    CkEmail_putSubject(email,"Quarterly report");
    CkEmail_putFrom(email,"alice@example.com");
    CkEmail_AddHeaderField(email,"X-Priority","1");

    //  Get header field values by name.
    printf("Subject = %s\n",CkEmail_getHeaderField(email,"Subject"));
    printf("From = %s\n",CkEmail_getHeaderField(email,"From"));
    printf("X-Priority = %s\n",CkEmail_getHeaderField(email,"x-priority"));


    CkEmail_Dispose(email);

    }