(JavaScript) Process New Email by Scanning for Senders

Scan email and save application-selected emails to EML files with unique filenames.

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 assumes 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("myLogin","myPassword");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

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

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

// Fetch messages from the mailbox using a search criteria.
// This example finds NEW emails: these are emails that have the RECENT flag set, but not the SEEN flag:
var messageSet = new CkMessageSet();
success = imap.QueryMbx("NEW",fetchUids,messageSet);
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

// This example will download headers, and then download
// the full email for those emails sent from a contact
// in our database.

// When downloading headers, each email object contains
// (obviously) the headers, but the body will be missing.
// Also, attachments will not be included.  However, it is
// possible to get information about the attachments
// as well as the complete size of the email.
var bundle = new CkEmailBundle();
var headersOnly = true;
success = imap.FetchMsgSet(headersOnly,messageSet,bundle);
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

// Loop over the email objects...
var emailHeader = new CkEmail();
var fullEmail = new CkEmail();
var i = 0;
var numEmails = bundle.MessageCount;
while (i < numEmails) {
    bundle.EmailAt(i,emailHeader);

    // The sender's email address and name are available
    // in the From, FromAddress, and FromName properties.
    // If the sender is "Chilkat Support <support@chilkatsoft.com",
    // then the From property will hold the entire string.
    // the FromName property contains"Chilkat Support",
    // and the FromAddress property contains "support@chilkatsoft.com"
    console.log(emailHeader.From);
    console.log(emailHeader.FromAddress);
    console.log(emailHeader.FromName);

    // Assume at this point your code checks to see if the sender
    // is one in your contacts database.  If so, this is
    // the code you would write to download the entire
    // email and save it to a file.

    // The ckx-imap-uid header field is added when
    // headers are downloaded.  This makes it possible
    // to get the UID from the email object.
    var uidStr = emailHeader.GetHeaderField("ckx-imap-uid");
    var uid = uidStr;

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

    // You can use the GenerateFilename method to
    // generate a unique filename...
    var filename = fullEmail.GenerateFilename();

    // SaveEml saves the entire email, including attachments.
    success = fullEmail.SaveEml(filename);

    console.log("--");

    i = i+1;
}

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