PureBasic

Delete a POP3 Message by Message Number

Demonstrates the Chilkat MailMan.DeleteByMsgnum method, which marks an email for deletion by its POP3 message number. Message numbers are specific to a single POP3 session and can change from one session to the next, so UIDLs are generally preferred for stable identification. This example marks message number 1 for deletion.

Background: In POP3, deletion is two-phase: messages are marked with the DELE command during the session, and the server only actually removes them when the session ends cleanly with QUIT. Message numbers are simple sequence positions (1, 2, 3, …) valid only within the current session — which is why DeleteByUidl is safer when you need to reliably target a specific message.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkMailMan.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the MailMan.DeleteByMsgnum method, which marks an email for deletion by its
    ;  POP3 message number.  Message numbers are specific to a single POP3 session and can
    ;  change between sessions, so UIDLs are generally preferred.

    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 message number 1 for deletion.

    success = CkMailMan::ckDeleteByMsgnum(mailman,1)
    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 message 1 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