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

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoImap
    Boolean iFetchUids
    Variant vMessageSet
    Handle hoMessageSet
    Variant vBundle
    Handle hoBundle
    Boolean iHeadersOnly
    Variant vEmail
    Handle hoEmail
    Variant vMsgSet1
    Handle hoMsgSet1
    Integer i
    Integer iSzBundle
    String sUidStr
    String sTemp1

    Move False To iSuccess

    // 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 = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Login
    Get ComLogin Of hoImap "login" "password" To iSuccess
    If (iSuccess = False) 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 = False) 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 Create (RefClass(cComChilkatMessageSet)) To hoMessageSet
    If (Not(IsComObjectCreated(hoMessageSet))) Begin
        Send CreateComObject of hoMessageSet
    End
    Get pvComObject of hoMessageSet to vMessageSet
    Get ComQueryMbx Of hoImap "ALL" iFetchUids vMessageSet To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatEmailBundle)) To hoBundle
    If (Not(IsComObjectCreated(hoBundle))) Begin
        Send CreateComObject of hoBundle
    End
    Move True To iHeadersOnly
    Get pvComObject of hoMessageSet to vMessageSet
    Get pvComObject of hoBundle to vBundle
    Get ComFetchMsgSet Of hoImap iHeadersOnly vMessageSet vBundle To iSuccess
    If (iSuccess = False) Begin
        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.
    Get Create (RefClass(cComChilkatEmail)) To hoEmail
    If (Not(IsComObjectCreated(hoEmail))) Begin
        Send CreateComObject of hoEmail
    End
    Get Create (RefClass(cComChilkatMessageSet)) To hoMsgSet1
    If (Not(IsComObjectCreated(hoMsgSet1))) Begin
        Send CreateComObject of hoMsgSet1
    End
    Move 0 To i
    Get ComMessageCount Of hoBundle To iSzBundle
    While (i < iSzBundle)
        Get pvComObject of hoEmail to vEmail
        Get ComEmailAt Of hoBundle i vEmail To iSuccess

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

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

        Move (i + 1) To i
    Loop

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


End_Procedure