(DataFlex) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoImap
    Boolean iSuccess
    Boolean iFetchUids
    Variant vMessageSet
    Handle hoMessageSet
    Variant vBundle
    Handle hoBundle
    Integer i
    Integer iSzBundle
    Variant vMsOneMsg
    Handle hoMsOneMsg
    Variant vEmail
    Handle hoEmail
    String sUidStr
    String sTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatImap)) To hoImap
    If (Not(IsComObjectCreated(hoImap))) Begin
        Send CreateComObject of hoImap
    End

    // Connect to an IMAP server.
    // Use TLS
    Set ComSsl Of hoImap To True
    Set ComPort Of hoImap To 993
    Get ComConnect Of hoImap "imap.someMailServer.com" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Login
    Get ComLogin Of hoImap "login" "password" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Select an IMAP mailbox
    Get ComSelectMailbox Of hoImap "Inbox" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Move True To iFetchUids
    // Get the message UIDs of all the emails in the mailbox
    Get ComSearch Of hoImap "ALL" iFetchUids To vMessageSet
    If (IsComObject(vMessageSet)) Begin
        Get Create (RefClass(cComChilkatMessageSet)) To hoMessageSet
        Set pvComObject Of hoMessageSet To vMessageSet
    End
    Get ComLastMethodSuccess Of hoImap To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComFetchHeaders Of hoImap vMessageSet To vBundle
    If (IsComObject(vBundle)) Begin
        Get Create (RefClass(cComChilkatEmailBundle)) To hoBundle
        Set pvComObject Of hoBundle To vBundle
    End
    Get ComLastMethodSuccess Of hoImap To bTemp1
    If (bTemp1 <> True) Begin
        Send Destroy of hoMessageSet
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // The UID of each fetched email header is available 
    // in the ckx-imap-uid header field.
    Move 0 To i
    Get ComMessageCount Of hoBundle To iSzBundle
    Get Create (RefClass(cComChilkatMessageSet)) To hoMsOneMsg
    If (Not(IsComObjectCreated(hoMsOneMsg))) Begin
        Send CreateComObject of hoMsOneMsg
    End
    While (i < iSzBundle)
        Get ComGetEmail Of hoBundle i To vEmail
        If (IsComObject(vEmail)) Begin
            Get Create (RefClass(cComChilkatEmail)) To hoEmail
            Set pvComObject Of hoEmail To vEmail
        End

        // Build a message set containing one UID
        Get ComGetHeaderField Of hoEmail "ckx-imap-uid" To sUidStr
        Get ComFromCompactString Of hoMsOneMsg sUidStr To iSuccess

        // Move this message to some other folder.
        Get pvComObject of hoMsOneMsg to vMsOneMsg
        Get ComMoveMessages Of hoImap vMsOneMsg "someOtherFolder" To iSuccess
        If (iSuccess <> True) Begin
            Get ComLastErrorText Of hoImap To sTemp1
            Showln sTemp1
            // Exit the loop...
            Move iSzBundle To i
        End

        Send Destroy of hoEmail
        Move (i + 1) To i
    Loop

    // Disconnect from the IMAP server.
    Get ComDisconnect Of hoImap To iSuccess

    Send Destroy of hoMessageSet
    Send Destroy of hoBundle


End_Procedure