JavaScript

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.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

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

var email = new CkEmail();
email.Subject = "Remove header field";
email.From = "alice@example.com";

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

//  Use HasHeaderMatching to test for the header's presence.  ("*" matches any value.)
var hasBefore = email.HasHeaderMatching("X-Custom-Header","*",false);
console.log("Has X-Custom-Header before: " + hasBefore);

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

var hasAfter = email.HasHeaderMatching("X-Custom-Header","*",false);
console.log("Has X-Custom-Header after: " + hasAfter);