Node.js

Fetch Full Email Given Email Header

When you fetch email headers using UIDs instead of sequence numbers, the email object (which includes only the header) will have auto-generated ckx-imap-* headers. These headers provide details like the UID and attachments. The IMAP UID is found in the ckx-imap-uid header. Additionally, the ckx-imap-isUid header indicates whether the email header was downloaded by UID, showing YES or NO. Since sequence numbers can change if emails are deleted, UIDs are essential for downloading the correct full email.

The Chilkat Email object offers a GetImapUid method to retrieve the UID from the ckx-imap-uid header. This UID can be used to fetch the full email.

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 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("***","***");
    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 emailHeader = new chilkat.Email();
    var emailFull = new chilkat.Email();

    var uid = 2014;
    var isUid = true;

    // Fetch only the email header
    success = imap.FetchEmail(true,uid,isUid,emailHeader);
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    // Now fetch the full email
    var uidFromCkxHeader = emailHeader.GetImapUid();
    if (uidFromCkxHeader < 0) {
        // Failed. 
        console.log("No ckx-imap-uid header was found.");
        return;
    }

    success = imap.FetchEmail(false,uid,isUid,emailFull);
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    // OK, we have the full email, do whatever we want...

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

}

chilkatExample();