PowerBuilder

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

Download Chilkat for PowerBuilder

PowerBuilder

integer li_rc
oleobject loo_Email
integer li_HasBefore
integer li_HasAfter

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

loo_Email = create oleobject
li_rc = loo_Email.ConnectToNewObject("Chilkat.Email")
if li_rc < 0 then
    destroy loo_Email
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_Email.Subject = "Remove header field"
loo_Email.From = "alice@example.com"

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

//  Use HasHeaderMatching to test for the header's presence.  ("*" matches any value.)
li_HasBefore = loo_Email.HasHeaderMatching("X-Custom-Header","*",0)
Write-Debug "Has X-Custom-Header before: " + string(li_HasBefore)

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

li_HasAfter = loo_Email.HasHeaderMatching("X-Custom-Header","*",0)
Write-Debug "Has X-Custom-Header after: " + string(li_HasAfter)


destroy loo_Email