PureBasic

Move Selected Emails to another Mailbox Folder

See more IMAP Examples

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

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

    ; 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")
    If success = 0
        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.
    email.i = CkEmail::ckCreate()
    If email.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    i.i = 0
    While i < numEmails
        ; Fetch the email by sequence number.
        success = CkImap::ckFetchEmail(imap,0,i + 1,0,email)
        If success = 0
            Debug CkImap::ckLastErrorText(imap)
            CkImap::ckDispose(imap)
            CkMessageSet::ckDispose(mset)
            CkEmail::ckDispose(email)
            ProcedureReturn
        EndIf

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

    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 = 0
            Debug CkImap::ckLastErrorText(imap)
            CkImap::ckDispose(imap)
            CkMessageSet::ckDispose(mset)
            CkEmail::ckDispose(email)
            ProcedureReturn
        EndIf

    EndIf

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


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


    ProcedureReturn
EndProcedure