JavaScript

Fetch a MessageSet into an EmailBundle

Demonstrates the Chilkat Imap.FetchMsgSet method, which downloads the messages identified by a MessageSet and appends them to an EmailBundle. The arguments are headersOnly, the MessageSet, and the EmailBundle (which is not cleared). This example searches for unseen messages and downloads the whole set.

Background: This is the natural pairing with QueryMbx: search to get a MessageSet of matching identifiers, then download exactly those messages in one call. Fetching a set is far more efficient than looping one message at a time, and it returns an EmailBundle you iterate with MessageCount and EmailAt. Pass headersOnly = true to pull just headers for a fast preview list.

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 Imap.FetchMsgSet method, which downloads the messages identified by a
//  MessageSet and appends them to an EmailBundle.  The 1st argument is headersOnly, the 2nd
//  is the MessageSet, and the 3rd is the EmailBundle (which is not cleared).

var imap = new CkImap();

imap.Ssl = true;
imap.Port = 993;

success = imap.Connect("imap.example.com");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

success = imap.Login("user@example.com","myPassword");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

success = imap.SelectMailbox("Inbox");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

//  Find the messages to download (here, the unseen messages by UID).
var msgSet = new CkMessageSet();
success = imap.QueryMbx("UNSEEN",true,msgSet);
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

//  Download the messages in the set (full bodies) into a bundle.
var bundle = new CkEmailBundle();
success = imap.FetchMsgSet(false,msgSet,bundle);
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

var n = bundle.MessageCount;
console.log("Fetched " + n + " messages.");
var email = new CkEmail();
var i;
for (i = 0; i <= n - 1; i++) {
    success = bundle.EmailAt(i,email);
    console.log(email.Subject);
}

success = imap.Disconnect();
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}