JavaScript

Fetch a Set of POP3 Messages by UIDL

Demonstrates the Chilkat MailMan.FetchUidlSet method, which retrieves the messages whose UIDLs are listed in a StringTable and appends them to an EmailBundle. The arguments are the UIDL StringTable, headersOnly, numBodyLines, and the EmailBundle. This example fetches two specific messages by UIDL.

Background: This is the efficient way to download a selected subset of a mailbox in one call — exactly the pattern for an incremental client: list the mailbox UIDLs, compare against the ones you've already stored, and fetch only the new UIDLs as a set. It avoids re-downloading messages you already have while still pulling everything new in a single operation.

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 MailMan.FetchUidlSet method, which retrieves the messages whose UIDLs are
//  listed in a StringTable and appends them to an EmailBundle.  The arguments are the UIDL
//  StringTable, headersOnly, numBodyLines, and the EmailBundle.  The messages remain on the
//  server.

var mailman = new CkMailMan();

//  Configure the POP3 server connection.
mailman.MailHost = "pop.example.com";
mailman.MailPort = 995;
mailman.PopSsl = true;
mailman.PopUsername = "user@example.com";
mailman.PopPassword = "myPassword";

//  Build the set of UIDLs to fetch.
var uidls = new CkStringTable();
uidls.Append("0000000123abcdef");
uidls.Append("0000000124abcdef");

//  Fetch the listed messages (full bodies) into a bundle.
//  headersOnly=false (fetch the entire message).
//  Note: numBodyLines only applies when headersOnly is true (it sets how many lines of the
//  body to include along with the headers).  When headersOnly is false, the entire message
//  is fetched and numBodyLines is ignored.
var bundle = new CkEmailBundle();

success = mailman.FetchUidlSet(uidls,false,0,bundle);
if (success == false) {
    console.log(mailman.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);
}

//  Note: Explicitly connecting/authenticating is optional.  Chilkat MailMan automatically
//  connects and authenticates -- using the property settings above -- whenever a server
//  operation requires it.  Calling the explicit connect/authenticate methods can still be
//  helpful to determine whether a failure occurs while connecting or while authenticating.