Node.js

Get IMAP Attachment Filenames

Demonstrates the Chilkat Imap.GetMailAttachFilename method, which returns the filename of an attachment. The first argument is the Email and the second is the zero-based attachment index. This example fetches only the message headers and lists the attachment filenames.

Background: This method reads the filename from ckx-imap-* metadata, so it works on a header-only email even though the attachment bodies have not been downloaded. That is exactly what a mail client needs to render the paperclip list — the names of the attached files — before the user decides to download any of them.

Chilkat Node.js Downloads

Download Chilkat for Node.js

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  Demonstrates the Imap.GetMailAttachFilename method, which returns the filename of an
    //  attachment.  The 1st argument is the Email and the 2nd is the zero-based attachment index.

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

    //  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 chilkat.Email();
    success = imap.FetchEmail(headersOnly,seqNum,useUid,email);
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    //  Loop over the attachments and print each filename.
    var numAttach = imap.GetMailNumAttach(email);
    console.log("Attachments: " + numAttach);
    var i;
    for (i = 0; i <= numAttach - 1; i++) {
        //  GetMailAttachFilename returns a string, so assign it to a string variable.
        var fname = imap.GetMailAttachFilename(email,i);
        if (imap.LastMethodSuccess == false) {
            console.log(imap.LastErrorText);
            return;
        }

        console.log(fname);
    }

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


}

chilkatExample();