Visual FoxPro

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 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 lcAttachText

lnSuccess = 0

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

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
    *  FetchAttachmentString returns a string, so assign it to a string variable.
    lcAttachText = loImap.FetchAttachmentString(loEmail,0,"utf-8")
    IF (loImap.LastMethodSuccess = 0) THEN
        ? loImap.LastErrorText
        RELEASE loImap
        RELEASE loEmail
        CANCEL
    ENDIF

    ? lcAttachText
ENDIF

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

RELEASE loImap
RELEASE loEmail