Fetch a Text IMAP Attachment as a String

See more IMAP Examples

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 C Downloads

Download Chilkat for C

#include <C_CkImap.h>
#include <C_CkEmail.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkImap imap;
    BOOL headersOnly;
    BOOL useUid;
    int seqNum;
    HCkEmail email;
    int numAttach;
    const char *attachText;

    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.

    imap = CkImap_Create();

    CkImap_putSsl(imap,TRUE);
    CkImap_putPort(imap,993);

    success = CkImap_Connect(imap,"imap.example.com");
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }

    success = CkImap_Login(imap,"user@example.com","myPassword");
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }

    success = CkImap_SelectMailbox(imap,"Inbox");
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        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.
    headersOnly = TRUE;
    useUid = FALSE;
    seqNum = 1;
    email = CkEmail_Create();
    success = CkImap_FetchEmail(imap,headersOnly,seqNum,useUid,email);
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        CkEmail_Dispose(email);
        return;
    }

    numAttach = CkImap_GetMailNumAttach(imap,email);
    if (numAttach > 0) {
        //  FetchAttachmentString returns a string, so assign it to a string variable.
        attachText = CkImap_fetchAttachmentString(imap,email,0,"utf-8");
        if (CkImap_getLastMethodSuccess(imap) == FALSE) {
            printf("%s\n",CkImap_lastErrorText(imap));
            CkImap_Dispose(imap);
            CkEmail_Dispose(email);
            return;
        }

        printf("%s\n",attachText);
    }

    success = CkImap_Disconnect(imap);
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        CkEmail_Dispose(email);
        return;
    }



    CkImap_Dispose(imap);
    CkEmail_Dispose(email);

    }