PureBasic

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 PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkMailMan.pb"

Procedure ChilkatExample()

    success.i = 0

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

    mailman.i = CkMailMan::ckCreate()
    If mailman.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  Configure the POP3 server connection.
    CkMailMan::setCkMailHost(mailman, "pop.example.com")
    CkMailMan::setCkMailPort(mailman, 995)
    CkMailMan::setCkPopSsl(mailman, 1)
    CkMailMan::setCkPopUsername(mailman, "user@example.com")
    CkMailMan::setCkPopPassword(mailman, "myPassword")

    ;  Mark a specific message for deletion by its UIDL.

    success = CkMailMan::ckDeleteByUidl(mailman,"0000000123abcdef")
    If success = 0
        Debug CkMailMan::ckLastErrorText(mailman)
        CkMailMan::ckDispose(mailman)
        ProcedureReturn
    EndIf

    ;  Unless the ImmediateDelete property is set to 1, the message is only marked for
    ;  deletion.  End the POP3 session (which sends the QUIT command) to commit the deletion
    ;  on the server.
    success = CkMailMan::ckPop3EndSession(mailman)
    If success = 0
        Debug CkMailMan::ckLastErrorText(mailman)
        CkMailMan::ckDispose(mailman)
        ProcedureReturn
    EndIf

    Debug "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.


    CkMailMan::ckDispose(mailman)


    ProcedureReturn
EndProcedure