(PureBasic) Fetch Single Email by UID or Sequence Number

Assuming the UID is known, download a single email by UID from an IMAP mail server.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkEmail.pb"
IncludeFile "CkImap.pb"

Procedure ChilkatExample()

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    imap.i = CkImap::ckCreate()
    If imap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to an IMAP server.
    ; Use TLS
    CkImap::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)
    success.i = CkImap::ckConnect(imap,"imap.someMailServer.com")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Login
    success = CkImap::ckLogin(imap,"***","***")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Select an IMAP mailbox
    success = CkImap::ckSelectMailbox(imap,"Inbox")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    email.i

    uid.i = 2014
    isUid.i = 1

    email = CkImap::ckFetchSingle(imap,uid,isUid)
    If CkImap::ckLastMethodSuccess(imap) = 1

        ; Display the From and Subject
        Debug CkEmail::ckFromAddress(email)
        Debug CkEmail::ckSubject(email)

        ; Display the Body property, which is the default body.
        ; If an email has an HTML body, the Body property contains
        ; the HTML source.  Otherwise it contains the plain-text
        ; body.
        Debug "---- EMAIL BODY ----"
        Debug CkEmail::ckBody(email)
        Debug "--------------------"

        ; Display the recipients:
        j.i
        For j = 0 To CkEmail::ckNumTo(email) - 1
            Debug CkEmail::ckGetToName(email,j) + ", " + CkEmail::ckGetToAddr(email,j)
        Next
        For j = 0 To CkEmail::ckNumCC(email) - 1
            Debug CkEmail::ckGetCcName(email,j) + ", " + CkEmail::ckGetCcAddr(email,j)
        Next

        ; Show the total size of the email, including body and attachments:
        Debug Str(CkEmail::ckSize(email))

        ; When a full email is downloaded, we would use the
        ; email.NumAttachments property in conjunction with the
        ; email.GetMailAttach* methods.
        ; However, when an email object contains only the header,
        ; we need to access the attachment info differently:
        numAttach.i = CkImap::ckGetMailNumAttach(imap,email)
        Debug Str(numAttach)

        For j = 0 To numAttach - 1
            Debug CkImap::ckGetMailAttachFilename(imap,email,j)
            attachSize.i = CkImap::ckGetMailAttachSize(imap,email,j)
            Debug "    size = " + Str(attachSize) + " bytes"
        Next

        Debug "--"
        CkEmail::ckDispose(email)

    EndIf

    ; Disconnect from the IMAP server.
    success = CkImap::ckDisconnect(imap)


    CkImap::ckDispose(imap)


    ProcedureReturn
EndProcedure