(PureBasic) Get IMAP UID from Email Header

Demonstrates how to get the IMAP UID from an email header. After fetching an email or header using IMAP, the UID is contained in the ckx-imap-uid header field.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkImap.pb"
IncludeFile "CkEmailBundle.pb"
IncludeFile "CkMessageSet.pb"
IncludeFile "CkEmail.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,"login","password")
    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

    fetchUids.i = 1
    ; Get the message UIDs of all the emails in the mailbox
    messageSet.i = CkImap::ckSearch(imap,"ALL",fetchUids)
    If CkImap::ckLastMethodSuccess(imap) <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    bundle.i = CkImap::ckFetchHeaders(imap,messageSet)
    If CkImap::ckLastMethodSuccess(imap) <> 1
        CkMessageSet::ckDispose(messageSet)

        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; The UID of each fetched email header is available 
    ; in the ckx-imap-uid header field.
    i.i = 0
    szBundle.i = CkEmailBundle::ckMessageCount(bundle)
    msOneMsg.i = CkMessageSet::ckCreate()
    If msOneMsg.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    While i < szBundle
        email.i = CkEmailBundle::ckGetEmail(bundle,i)

        ; Build a message set containing one UID
        uidStr.s = CkEmail::ckGetHeaderField(email,"ckx-imap-uid")
        CkMessageSet::ckFromCompactString(msOneMsg,uidStr)

        ; Move this message to some other folder.
        success = CkImap::ckMoveMessages(imap,msOneMsg,"someOtherFolder")
        If success <> 1
            Debug CkImap::ckLastErrorText(imap)
            ; Exit the loop...
            i = szBundle
        EndIf

        CkEmail::ckDispose(email)

        i = i + 1
    Wend

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

    CkMessageSet::ckDispose(messageSet)

    CkEmailBundle::ckDispose(bundle)



    CkImap::ckDispose(imap)
    CkMessageSet::ckDispose(msOneMsg)


    ProcedureReturn
EndProcedure