Lianja

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

Download Chilkat for Lianja

Lianja

llSuccess = .F.

//  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("CkImap")

loImap.Ssl = .T.
loImap.Port = 993

llSuccess = loImap.Connect("imap.example.com")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

llSuccess = loImap.Login("user@example.com","myPassword")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

llSuccess = loImap.SelectMailbox("Inbox")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
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.
llHeadersOnly = .T.
llUseUid = .F.
lnSeqNum = 1
loEmail = createobject("CkEmail")
llSuccess = loImap.FetchEmail(llHeadersOnly,lnSeqNum,llUseUid,loEmail)
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loEmail
    return
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 = .F.) then
        ? loImap.LastErrorText
        release loImap
        release loEmail
        return
    endif

    ? lcAttachText
endif

llSuccess = loImap.Disconnect()
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loEmail
    return
endif



release loImap
release loEmail