DataFlex

Fetch One POP3 Message by UIDL

Demonstrates the Chilkat MailMan.FetchByUidl method, which retrieves one message by UIDL and stores it in an Email object. The arguments are the UIDL, headerOnly, numBodyLines, and the Email. The message remains on the POP3 server. This example fetches a specific message by its UIDL.

Background: Because a UIDL is stable across sessions, fetching by UIDL is the reliable way to retrieve exactly the message you mean — the foundation of "leave on server" clients that remember which UIDLs they've already processed and download only the new ones. You can obtain the mailbox's UIDLs from FetchUidls or GetMailboxInfoXml.

Chilkat DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoMailman
    Variant vEmail
    Handle hoEmail
    String sTemp1

    Move False To iSuccess

    //  Demonstrates the MailMan.FetchByUidl method, which retrieves one message by UIDL and
    //  stores it in an Email object.  The arguments are the UIDL, headerOnly, numBodyLines, and
    //  the Email.  The message remains on the server.

    Get Create (RefClass(cComChilkatMailMan)) To hoMailman
    If (Not(IsComObjectCreated(hoMailman))) Begin
        Send CreateComObject of hoMailman
    End

    //  Configure the POP3 server connection.
    Set ComMailHost Of hoMailman To "pop.example.com"
    Set ComMailPort Of hoMailman To 995
    Set ComPopSsl Of hoMailman To True
    Set ComPopUsername Of hoMailman To "user@example.com"
    Set ComPopPassword Of hoMailman To "myPassword"

    //  Fetch a specific message by UIDL in full.  headerOnly=False (fetch the entire message).
    //  Note: numBodyLines only applies when headersOnly is True (it sets how many lines of the
    //  body to include along with the headers).  When headersOnly is False, the entire message
    //  is fetched and numBodyLines is ignored.
    Get Create (RefClass(cComChilkatEmail)) To hoEmail
    If (Not(IsComObjectCreated(hoEmail))) Begin
        Send CreateComObject of hoEmail
    End

    Get pvComObject of hoEmail to vEmail
    Get ComFetchByUidl Of hoMailman "0000000123abcdef" False 0 vEmail To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoMailman To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComSubject Of hoEmail To sTemp1
    Showln "Subject: " sTemp1

    //  Note: Explicitly connecting/authenticating is optional.  Chilkat MailMan automatically
    //  connects and authenticates -- using the property settings above -- whenever a server
    //  operation requires it.  Calling the explicit connect/authenticate methods can still be
    //  helpful to determine whether a failure occurs while connecting or while authenticating.


End_Procedure