PureBasic

Move Messages from one Mailbox to Another

If your IMAP server supports the MOVE capability, then it is possible to move messages from one mailbox (folder) to another. This example demonstrates the MOVE command using the SendRawCommand method. The IMAP MOVE Extension is documented in RFC 6851. PureBasic

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

Procedure ChilkatExample()

    success.i = 0

    ; This example assumes 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

    ; Use an implicit TLS connection.
    CkImap::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)
    success = CkImap::ckConnect(imap,"MY-IMAP-DOMAIN")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Authenticate
    success = CkImap::ckLogin(imap,"MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Get the list of capabilities:
    caps.s = CkImap::ckCapability(imap)
    Debug "Capabilities: " + caps

    ; Here is an example of the string returned:
    ; * CAPABILITY IMAP4rev1 UNSELECT IDLE NAMESPACE QUOTA ID XLIST CHILDREN X-GM-EXT-1 
    ; UIDPLUS COMPRESS=DEFLATE ENABLE MOVE CONDSTORE ESEARCH UTF8=ACCEPT APPENDLIMIT=35882577
    ; LIST-EXTENDED LIST-STATUS

    If CkImap::ckHasCapability(imap,"MOVE",caps) <> 1
        Debug "The IMAP server does not support the MOVE extension."
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    Debug "Good, the MOVE extension is supported..."

    ; Select a mailbox, search for some messages to get a sequence-set (i.e. a 
    ; range of message sequence numbers or UIDs.  Then move these messages to another
    ; mailbox.

    success = CkImap::ckSelectMailbox(imap,"old")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Get a set of message sequence numbers for all emails with "Gencer" in the FROM name/address.
    bReturnUids.i = 0

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

    success = CkImap::ckQueryMbx(imap,"FROM Gencer",bReturnUids,msgSet)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkMessageSet::ckDispose(msgSet)
        ProcedureReturn
    EndIf

    ; The message set, as a compact string, will look something like this:
    ; 1572,1876:1881,1883,1886,1895,1905:1906,1910:1911,1923,1959:1963
    sequenceSet.s = CkMessageSet::ckToCompactString(msgSet)
    Debug sequenceSet

    ; Let's form our MOVE command.
    sbMoveCmd.i = CkStringBuilder::ckCreate()
    If sbMoveCmd.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbMoveCmd,"MOVE ")
    CkStringBuilder::ckAppend(sbMoveCmd,sequenceSet)
    CkStringBuilder::ckAppend(sbMoveCmd," old/gencer")
    Debug "Sending: " + CkStringBuilder::ckGetAsString(sbMoveCmd)

    cmdResponse.s = CkImap::ckSendRawCommand(imap,CkStringBuilder::ckGetAsString(sbMoveCmd))
    If CkImap::ckLastMethodSuccess(imap) = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkMessageSet::ckDispose(msgSet)
        CkStringBuilder::ckDispose(sbMoveCmd)
        ProcedureReturn
    EndIf

    Debug cmdResponse

    ; The response looks like this:
    ; 	* 1572 EXPUNGE
    ; 	* 1875 EXPUNGE
    ; 	* 1875 EXPUNGE
    ; 	* 1875 EXPUNGE
    ; 	* 1875 EXPUNGE
    ; 	* 1875 EXPUNGE
    ; 	* 1875 EXPUNGE
    ; 	* 1876 EXPUNGE
    ; 	* 1878 EXPUNGE
    ; 	* 1886 EXPUNGE
    ; 	* 1895 EXPUNGE
    ; 	* 1895 EXPUNGE
    ; 	* 1898 EXPUNGE
    ; 	* 1898 EXPUNGE
    ; 	* 1909 EXPUNGE
    ; 	* 1944 EXPUNGE
    ; 	* 1944 EXPUNGE
    ; 	* 1944 EXPUNGE
    ; 	* 1944 EXPUNGE
    ; 	* 1944 EXPUNGE
    ; 	* 2274 EXISTS
    ; 	aaaf OK [COPYUID 62 1582,1886:1891,1893,1896,1905,1915:1916,1920:1921,1933,1974:1978 20,17,16,15,14,13,12,10:11,9,19,18,8,7,6,5,4,3,2,1] (Success)

    ; The last line should indicate OK.

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

    Debug "All Done."


    CkImap::ckDispose(imap)
    CkMessageSet::ckDispose(msgSet)
    CkStringBuilder::ckDispose(sbMoveCmd)


    ProcedureReturn
EndProcedure