JavaScript

Get a Summary of the MIME Structure

Demonstrates the Chilkat Mime.GetStructure method, which returns a concise summary of the MIME tree. The only argument selects the format: xml for XML, or text (the default for any other value) for a plain-text outline.

Note: The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: A real message can nest multipart containers several levels deep — a multipart/mixed holding a multipart/alternative of text and HTML plus attachments — and GetStructure renders that hierarchy at a glance without the full content. It is the fast way to understand or debug an unfamiliar message's layout, in either a readable text outline or machine-parseable XML.

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

var success = false;

//  Demonstrates the Mime.GetStructure method, which returns a concise summary of the MIME tree.
//  The only argument selects the output format: "xml" for XML, or "text" (the default) for a
//  plain-text outline.

var mime = new CkMime();

success = mime.LoadMimeFile("qa_data/multipart_message.eml");
if (success == false) {
    console.log(mime.LastErrorText);
    return;
}

//  Get a human-readable text outline of the MIME structure.
var structure = mime.GetStructure("text");
if (mime.LastMethodSuccess == false) {
    console.log(mime.LastErrorText);
    return;
}

console.log(structure);