Xbase++

Remove a Header Field from an Email

Demonstrates the Chilkat Email.RemoveHeaderField method, which removes by name all occurrences of a header field. Header-field names are case-insensitive, and every repeated occurrence with the given name is removed. This example adds a custom header, then removes it.

Background: Editing a message sometimes means deleting a header outright — stripping a tracking header, removing an X- flag before forwarding, or clearing a stale field before re-sending. Because a field name can appear more than once (like Received), RemoveHeaderField removes all matching occurrences in one call rather than just the first.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL oEmail
LOCAL nHasBefore
LOCAL nHasAfter

//  Demonstrates the RemoveHeaderField method, which removes by name all occurrences of a
//  header field.  Header-field names are case-insensitive.

oEmail := CreateObject("Chilkat.Email")
oEmail:Subject := "Remove header field"
oEmail:From := "alice@example.com"

oEmail:AddHeaderField("X-Custom-Header", "some value")

//  Use HasHeaderMatching to test for the header's presence.  ("*" matches any value.)
nHasBefore := oEmail:HasHeaderMatching("X-Custom-Header", "*", 0)
? "Has X-Custom-Header before: " + Str(nHasBefore)

//  Remove all occurrences of the header field.
oEmail:RemoveHeaderField("X-Custom-Header")

nHasAfter := oEmail:HasHeaderMatching("X-Custom-Header", "*", 0)
? "Has X-Custom-Header after: " + Str(nHasAfter)

oEmail:destroy()