Node.js

Download an IMAP Message Set

Demonstrates how to read a set of IMAP emails. Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  This example requires the Chilkat API to have been previously unlocked.
    //  See Global Unlock Sample for sample code.

    var imap = new chilkat.Imap();

    //  Connect using TLS.
    imap.Ssl = true;
    imap.Port = 993;
    success = imap.Connect("imap.example.com");
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    //  Authenticate
    success = imap.Login("email_account_login","email_account_password");
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    //  Select an IMAP mailbox
    success = imap.SelectMailbox("Inbox");
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    //  Search for messages with the word "test" in the subject.
    var fetchUids = true;

    var messageSet = new chilkat.MessageSet();
    success = imap.QueryMbx("Subject test",fetchUids,messageSet);
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    //  Download the messages in a single call to FetchMsgSet.
    //  
    //  This only makes sense if the number of emails to be downloaded is not too large.  
    //  For example, you wouldn't want to download 10000 emails in a single call to FetchMsgSet.
    //  Why? For two reasons:  (1) It could potentially cause an out-of-memory condition, and 
    //  (2) it would take an extremely large amount of time.  The longer the amount of time,
    //  the greater the likelihood of some kind of external networking or server problem occuring,
    //  and if it happens, then you would need to re-download everything from the beginning again.
    //  For large numbers of emails, it's better to loop over the emails in the message set
    //  and download/process one at a time as shown here: Download IMAP Messages One at a Time
    //  Downloading one message at a time makes it possible to resume the downloads rather than restart the entire operation all over again.

    //  If the message set is reasonable in size, you can download all at once using FetchMsgSet:

    console.log("Number of messages = " + messageSet.Count);

    var bundle = new chilkat.EmailBundle();
    var headersOnly = false;
    success = imap.FetchMsgSet(headersOnly,messageSet,bundle);
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    //  Display the Subject and From of each email.
    var email = new chilkat.Email();
    var i = 0;
    var numEmails = bundle.MessageCount;
    while (i < numEmails) {
        bundle.EmailAt(i,email);

        console.log(email.GetHeaderField("Date"));
        console.log(email.Subject);
        console.log(email.From);
        console.log("--");
        i = i+1;
    }


}

chilkatExample();