Node.js

Fetch a Text IMAP Attachment as a String

Demonstrates the Chilkat Imap.FetchAttachmentString method, which returns one text attachment decoded to a string. The first argument is the Email, the second is the zero-based attachment index, and the third is the charset used to decode the bytes. This example returns the first attachment as a UTF-8 string.

Background: This is the convenient form when you simply want a small text attachment's content inline as a string. Only use it for attachments known to be text; decoding binary content through a charset can alter or corrupt the bytes. For binary data use FetchAttachmentBd, and for large text a StringBuilder (via FetchAttachmentSb) avoids an extra copy.

Chilkat Node.js Downloads

Download Chilkat for Node.js

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  Demonstrates the Imap.FetchAttachmentString method, which downloads one text attachment and
    //  returns it decoded to a string.  The 1st argument is the Email, the 2nd is the zero-based
    //  attachment index, and the 3rd is the charset used to decode the bytes.
    //  
    //  The message is fetched headers-only, then the attachment is downloaded on demand.

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

    var numAttach = imap.GetMailNumAttach(email);
    if (numAttach > 0) {
        //  FetchAttachmentString returns a string, so assign it to a string variable.
        var attachText = imap.FetchAttachmentString(email,0,"utf-8");
        if (imap.LastMethodSuccess == false) {
            console.log(imap.LastErrorText);
            return;
        }

        console.log(attachText);
    }

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


}

chilkatExample();