Node.js

Refresh an Email Object's IMAP Flags

Demonstrates the Chilkat Imap.RefetchMailFlags method, which updates the flags stored on an Email object to the current values on the server. The only argument is the Email object. This example re-reads the flags for a previously fetched message and then checks its Seen state.

Background: Flags are shared mailbox state, so between the time you fetch a message and the time you act on it, another client (a phone, a webmail tab) may have marked it read, flagged, or deleted. RefetchMailFlags pulls just the flags — not the whole message — so a long-running job can cheaply re-check the live state before deciding what to do, avoiding acting on stale information.

Chilkat Node.js Downloads

Download Chilkat for Node.js

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  Demonstrates the Imap.RefetchMailFlags method, which updates the flags stored on an Email
    //  object to the current values on the server.  The only argument is the Email object.

    var imap = new chilkat.Imap();

    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;
    }

    var msgSet = new chilkat.MessageSet();
    success = imap.QueryMbx("ALL",true,msgSet);
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

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

    var email = new chilkat.Email();
    if (bundle.MessageCount > 0) {
        success = bundle.EmailAt(0,email);

        //  Re-read the flags from the server, in case another client changed them since the fetch.
        success = imap.RefetchMailFlags(email);
        if (success == false) {
            console.log(imap.LastErrorText);
            return;
        }

        var seen = imap.GetMailFlag(email,"Seen");
        console.log("Current Seen state: " + seen);
    }

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


}

chilkatExample();