(JavaScript) Get IMAP UID from Email Header

Demonstrates how to get the IMAP UID from an email header. After fetching an email or header using IMAP, the UID is contained in the ckx-imap-uid header field.

Note: This example requires Chilkat v11.0.0 or greater.

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.

var success = false;

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

var imap = new CkImap();

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

// Login
success = imap.Login("login","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;
}

var fetchUids = true;
// Get the message UIDs of all the emails in the mailbox

var messageSet = new CkMessageSet();
success = imap.QueryMbx("ALL",fetchUids,messageSet);
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

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

// The UID of each fetched email header is available 
// in the ckx-imap-uid header field.
var email = new CkEmail();
var msgSet1 = new CkMessageSet();
var i = 0;
var szBundle = bundle.MessageCount;
while (i < szBundle) {
    bundle.EmailAt(i,email);

    // Build a message set containing one UID
    var uidStr = email.GetHeaderField("ckx-imap-uid");
    msgSet1.FromCompactString(uidStr);

    // Move this message to some other folder.
    success = imap.MoveMessages(msgSet1,"someOtherFolder");
    if (success !== true) {
        console.log(imap.LastErrorText);
        // Exit the loop...
        i = szBundle;
    }

    i = i+1;
}

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