Visual FoxPro

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.

Chilkat Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loImap
LOCAL lnHeadersOnly
LOCAL lnUseUid
LOCAL lnSeqNum
LOCAL loEmail
LOCAL lnNumAttach
LOCAL loSb
LOCAL lcAttachText

lnSuccess = 0

*  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.

loImap = CreateObject('Chilkat.Imap')

loImap.Ssl = 1
loImap.Port = 993

lnSuccess = loImap.Connect("imap.example.com")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

lnSuccess = loImap.Login("user@example.com","myPassword")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

lnSuccess = loImap.SelectMailbox("Inbox")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

*  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.
lnHeadersOnly = 1
lnUseUid = 0
lnSeqNum = 1
loEmail = CreateObject('Chilkat.Email')
lnSuccess = loImap.FetchEmail(lnHeadersOnly,lnSeqNum,lnUseUid,loEmail)
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loEmail
    CANCEL
ENDIF

lnNumAttach = loImap.GetMailNumAttach(loEmail)
IF (lnNumAttach > 0) THEN
    *  Download the first (text) attachment and decode it as UTF-8.  Use this only for text.
    loSb = CreateObject('Chilkat.StringBuilder')
    lnSuccess = loImap.FetchAttachmentSb(loEmail,0,"utf-8",loSb)
    IF (lnSuccess = 0) THEN
        ? loImap.LastErrorText
        RELEASE loImap
        RELEASE loEmail
        RELEASE loSb
        CANCEL
    ENDIF

    lcAttachText = loSb.GetAsString()
    ? lcAttachText
ENDIF

lnSuccess = loImap.Disconnect()
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loEmail
    RELEASE loSb
    CANCEL
ENDIF

RELEASE loImap
RELEASE loEmail
RELEASE loSb