JavaScript

Fetch a Text IMAP Attachment into a StringBuilder

Demonstrates the Chilkat Imap.FetchAttachmentSb method, which decodes one text attachment into a StringBuilder. The first argument is the Email, the second is the zero-based attachment index, the third is the charset used to decode the bytes, and the fourth is the StringBuilder, which is cleared first. This example decodes the first attachment as UTF-8.

Background: For text attachments — a CSV, a .txt, an XML file — decoding straight to characters saves a manual charset step. The charset argument names the encoding of the attachment bytes (for example utf-8 or iso-8859-1). For binary attachments, use FetchAttachmentBd instead, since forcing binary through a text decoder can corrupt it.

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.FetchAttachmentSb method, which downloads one text attachment and
//  decodes it into a StringBuilder.  The 1st argument is the Email, the 2nd is the zero-based
//  attachment index, the 3rd is the charset used to decode, and the 4th is the StringBuilder
//  (cleared first).
//  
//  The message is fetched headers-only, then the attachment is downloaded on demand.

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);
if (numAttach > 0) {
    //  Download the first (text) attachment and decode it as UTF-8.  Use this only for text.
    var sb = new CkStringBuilder();
    success = imap.FetchAttachmentSb(email,0,"utf-8",sb);
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    var attachText = sb.GetAsString();
    console.log(attachText);
}

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