(DataFlex) Read IMAP Email Headers

Call FetchHeaders to download only the email headers.

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
    String sName
    String sAddr
    Integer i
    Integer j
    Integer iNumAttach
    Integer iAttachSize
    String sTemp1
    String sTemp2
    Integer iTemp1

    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.example.com" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Login
    Get ComLogin Of hoImap "****" "****" 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

    // Get the message IDs of all the emails in the mailbox
    // We can choose to fetch UIDs or sequence numbers.
    Move True To iFetchUids
    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

    // When downloading headers, each email object contains
    // (obviously) the headers, but the body will be missing.
    // Also, attachments will not be included.  However, it is
    // possible to get information about the attachments
    // as well as the complete size of the email.
    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

    // Loop over the email objects and display information
    // about each:
    Get Create (RefClass(cComChilkatEmail)) To hoEmail
    If (Not(IsComObjectCreated(hoEmail))) Begin
        Send CreateComObject of hoEmail
    End

    Move 0 To i
    Move 0 To j
    While (i < (ComMessageCount(hoBundle)))
        Get pvComObject of hoEmail to vEmail
        Get ComEmailAt Of hoBundle i vEmail To iSuccess

        // Display the From and Subject
        Get ComFrom Of hoEmail To sTemp1
        Showln sTemp1
        Get ComSubject Of hoEmail To sTemp1
        Showln sTemp1

        // Display the recipients:
        Move 0 To j
        While (j < (ComNumTo(hoEmail)))
            Get ComGetToName Of hoEmail j To sTemp1
            Get ComGetToAddr Of hoEmail j To sTemp2
            Showln "TO: " sTemp1 ", " sTemp2
            Move (j + 1) To j
        Loop

        Move 0 To j
        While (j < (ComNumCC(hoEmail)))
            Get ComGetCcName Of hoEmail j To sTemp1
            Get ComGetCcAddr Of hoEmail j To sTemp2
            Showln "CC: " sTemp1 ", " sTemp2
            Move (j + 1) To j
        Loop

        // Show the total size of the email, including body and attachments:
        Get ComSize Of hoEmail To iTemp1
        Showln iTemp1

        // 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:
        Get pvComObject of hoEmail to vEmail
        Get ComGetMailNumAttach Of hoImap vEmail To iNumAttach
        Move 0 To j
        While (j < iNumAttach)
            Get ComGetMailAttachFilename Of hoImap             Get pvComObject of hoEmail to vEmail
vEmail j To sTemp1
            Showln sTemp1
            Get pvComObject of hoEmail to vEmail
            Get ComGetMailAttachSize Of hoImap vEmail j To iAttachSize
            Showln "    size = " iAttachSize " bytes"
            Move (j + 1) To j
        Loop

        Showln "--"
    Loop

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


End_Procedure