(Node.js) Determine the Number of Unseen Email Messages

Demonstrates how to determine how many unseen messages exist in an email account on an IMAP server.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var imap = new chilkat.Imap();

    // Connect to an IMAP server.
    // Use TLS
    imap.Ssl = true;
    imap.Port = 993;
    var success = imap.Connect("imap.someMailServer.com");
    if (success !== true) {
        console.log(imap.LastErrorText);
        return;
    }

    // Login
    success = imap.Login("***","***");
    if (success !== true) {
        console.log(imap.LastErrorText);
        return;
    }

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

    // After selecting the mailbox. the total number of emails
    // is immediately available:
    var totalNum = imap.NumMessages;
    console.log("Num messages = " + totalNum);

    // To determine the number of unseen messages, a call
    // to Search is required, which returns the set of UIDs
    // of all unseen messages.

    // We can choose to fetch UIDs or sequence numbers.
    var fetchUids = true;

    // messageSet: MessageSet
    var messageSet = imap.Search("UNSEEN",fetchUids);
    if (imap.LastMethodSuccess == false) {
        console.log(imap.LastErrorText);
        return;
    }

    var numUnseen = messageSet.Count;
    console.log(numUnseen);

    console.log("UIDs ----");

    // Display the UIDs
    var i = 0;
    while (i < messageSet.Count) {
        console.log(messageSet.GetId(i));
        i = i+1;
    }

    // Disconnect from the IMAP server.
    success = imap.Disconnect();


}

chilkatExample();