PureBasic Requires Chilkat v11.0.0+

Delete All IMAP Email

Demonstrates two ways to delete all email in a mailbox on an IMAP server. PureBasic

IncludeFile "CkImap.pb"
IncludeFile "CkMessageSet.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  This example requires the Chilkat API to have been previously unlocked.
    ;  See Global Unlock Sample for sample code.

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

    ;  Turn on session logging:
    CkImap::setCkKeepSessionLog(imap, 1)

    ;  Connect to an IMAP server.
    ;  Use TLS
    CkImap::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)
    success = CkImap::ckConnect(imap,"imap.example.com")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ;  Login
    success = CkImap::ckLogin(imap,"myLogin","myPassword")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ;  Select an IMAP mailbox
    success = CkImap::ckSelectMailbox(imap,"Inbox.RubyMail")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ;  Get the complete set of Uids for email in the selected mailbox.
    messageSet.i = CkMessageSet::ckCreate()
    If messageSet.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkImap::ckQueryMbx(imap,"ALL",1,messageSet)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkMessageSet::ckDispose(messageSet)
        ProcedureReturn
    EndIf

    ;  Set the Deleted flag for each message.
    ;  (ExpungeAndClose must be called to finalize the delete.)
    success = CkImap::ckSetFlags(imap,messageSet,"Deleted",1)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkMessageSet::ckDispose(messageSet)
        ProcedureReturn
    EndIf

    ;  Alternatively, the Deleted flag may be set for each UID
    ;  individiually, but this is less efficient:
    i.i = 0
    n.i = CkMessageSet::ckCount(messageSet)
    While i < n
        success = CkImap::ckSetFlag(imap,CkMessageSet::ckGetId(messageSet,i),CkMessageSet::ckHasUids(messageSet),"Deleted",1)
        If success = 0
            Debug CkImap::ckLastErrorText(imap)
            CkImap::ckDispose(imap)
            CkMessageSet::ckDispose(messageSet)
            ProcedureReturn
        EndIf

        i = i + 1
    Wend

    ;  Expunge and close the mailbox.
    success = CkImap::ckExpungeAndClose(imap)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkMessageSet::ckDispose(messageSet)
        ProcedureReturn
    EndIf

    ;  Display the session log.
    Debug CkImap::ckSessionLog(imap)

    ;  Disconnect from the IMAP server.
    success = CkImap::ckDisconnect(imap)


    CkImap::ckDispose(imap)
    CkMessageSet::ckDispose(messageSet)


    ProcedureReturn
EndProcedure