Lianja

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

Download Chilkat for Lianja

Lianja

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

loEmail = createobject("CkEmail")
loEmail.Subject = "Remove header field"
loEmail.From = "alice@example.com"

loEmail.AddHeaderField("X-Custom-Header","some value")

//  Use HasHeaderMatching to test for the header's presence.  ("*" matches any value.)
llHasBefore = loEmail.HasHeaderMatching("X-Custom-Header","*",.F.)
? "Has X-Custom-Header before: " + str(llHasBefore)

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

llHasAfter = loEmail.HasHeaderMatching("X-Custom-Header","*",.F.)
? "Has X-Custom-Header after: " + str(llHasAfter)


release loEmail