(PureBasic) Delete All IMAP Email

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

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

Procedure ChilkatExample()

    ; 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.i = CkImap::ckConnect(imap,"imap.someMailServer.com")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

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

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

    messageSet.i

    ; Get the complete set of Uids for email in the selected mailbox.
    messageSet = CkImap::ckGetAllUids(imap)
    If CkImap::ckLastMethodSuccess(imap) <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        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 <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

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

    Next

    ; Expunge and close the mailbox.
    success = CkImap::ckExpungeAndClose(imap)
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

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

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

    CkMessageSet::ckDispose(messageSet)



    CkImap::ckDispose(imap)


    ProcedureReturn
EndProcedure