DataFlex

Delete a POP3 Message by UIDL

Demonstrates the Chilkat MailMan.DeleteByUidl method, which marks the POP3 message identified by a UIDL for deletion. UIDLs are preferred over message numbers because they remain stable across sessions while the message stays in the mailbox. This example marks a message for deletion by its UIDL.

Background: Because a UIDL uniquely and persistently identifies a message, deleting by UIDL is the reliable way to remove exactly the message you intend — even if the mailbox changed since you last looked. As with all POP3 deletion, the message is only marked during the session and is actually removed when the session ends normally (the QUIT command).

Chilkat DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoMailman
    String sTemp1

    Move False To iSuccess

    //  Demonstrates the MailMan.DeleteByUidl method, which marks the POP3 message identified by
    //  a UIDL for deletion.  UIDLs are preferred over message numbers because they remain stable
    //  across sessions while the message remains in the mailbox.

    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"

    //  Mark a specific message for deletion by its UIDL.

    Get ComDeleteByUidl Of hoMailman "0000000123abcdef" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoMailman To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  Unless the ImmediateDelete property is set to True, the message is only marked for
    //  deletion.  End the POP3 session (which sends the QUIT command) to commit the deletion
    //  on the server.
    Get ComPop3EndSession Of hoMailman To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoMailman To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "Deleted the message from the POP3 server."

    //  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