(PureBasic) Move Selected Emails to another Mailbox Folder

Downloads emails one by one in a selected mailbox, decides which emails are to be moved, and then moves the set of messages to another mailbox folder.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkImap.pb"
IncludeFile "CkMessageSet.pb"
IncludeFile "CkEmail.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

    ; 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")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Normally, when an email is downloaded, its "Seen" flag is automatically set.
    ; We don't want our program to be interfering with the "Seen" flags.
    ; To do this, set the PeekMode to 1.
    CkImap::setCkPeekMode(imap, 1)

    ; After selecting the mailbox, the NumMessages property
    ; will contain the number of emails in the mailbox.
    ; When sequence numbers (not UIDs) are used to reference emails,
    ; they range from 1 to N, where N is the number of messages in the mailbox.
    ; This example will download the headers by sequence numbers.
    numEmails.i = CkImap::ckNumMessages(imap)

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

    ; Indicate that mset contains sequence numbers, not UIDs.
    CkMessageSet::setCkHasUids(mset, 0)

    ; Fetch each email and decide for each if it is to be moved
    ; to a particular other mailbox.  If so, we'll add the sequence number to
    ; the mset, and then move all emails in the mset to the other mailbox.
    i.i = 0
    While i < numEmails
        ; Fetch the email by sequence number.
        email.i = CkImap::ckFetchSingle(imap,i + 1,0)
        If CkImap::ckLastMethodSuccess(imap) <> 1
            Debug CkImap::ckLastErrorText(imap)
            CkImap::ckDispose(imap)
            CkMessageSet::ckDispose(mset)
            ProcedureReturn
        EndIf

        ; If it is decided to move the email, add the sequence number to mset, like this:
        CkMessageSet::ckInsertId(mset,i + 1)

        CkEmail::ckDispose(email)

    Wend

    ; If there are emails in mset to be moved, then do it..
    If CkMessageSet::ckCount(mset) > 0
        destFolder.s = "Inbox/SomeOtherFolder"
        ; Assuming your IMAP server supports the feature that allows for messages to be moved to another folder...
        success = CkImap::ckMoveMessages(imap,mset,destFolder)
        If success <> 1
            Debug CkImap::ckLastErrorText(imap)
            CkImap::ckDispose(imap)
            CkMessageSet::ckDispose(mset)
            ProcedureReturn
        EndIf

    EndIf

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


    CkImap::ckDispose(imap)
    CkMessageSet::ckDispose(mset)


    ProcedureReturn
EndProcedure