JavaScript

Get the Number of IMAP Attachments

Demonstrates the Chilkat Imap.GetMailNumAttach method, which returns the number of ordinary attachments on a message. The only argument is the Email. This example fetches only the headers and reports the attachment count.

Background: A header-only fetch downloads no attachment bodies, so the Email object's own downloaded-attachment count can be 0. GetMailNumAttach instead reads the ckx-imap-numAttach metadata, giving the true count — which is what you want when building a message list that shows whether each message has attachments.

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.

JavaScript

var success = false;

//  Demonstrates the Imap.GetMailNumAttach method, which returns the number of ordinary
//  attachments on a message.  The only argument is the Email.

var imap = new CkImap();

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

//  Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
//  metadata describing the attachments is present, so the attachment info methods still work.
var headersOnly = true;
var useUid = false;
var seqNum = 1;
var email = new CkEmail();
success = imap.FetchEmail(headersOnly,seqNum,useUid,email);
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

var numAttach = imap.GetMailNumAttach(email);
console.log("This message has " + numAttach + " attachment(s).");

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