Visual FoxPro

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. Visual FoxPro

LOCAL lnSuccess
LOCAL loImap
LOCAL lcCaps
LOCAL lnBReturnUids
LOCAL loMsgSet
LOCAL lcSequenceSet
LOCAL loSbMoveCmd
LOCAL lcCmdResponse

lnSuccess = 0

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

loImap = CreateObject('Chilkat.Imap')

* Use an implicit TLS connection.
loImap.Ssl = 1
loImap.Port = 993
lnSuccess = loImap.Connect("MY-IMAP-DOMAIN")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* Authenticate
lnSuccess = loImap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* Get the list of capabilities:
lcCaps = loImap.Capability()
? "Capabilities: " + lcCaps

* 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 (loImap.HasCapability("MOVE",lcCaps) <> 1) THEN
    ? "The IMAP server does not support the MOVE extension."
    RELEASE loImap
    CANCEL
ENDIF

? "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.

lnSuccess = loImap.SelectMailbox("old")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

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

loMsgSet = CreateObject('Chilkat.MessageSet')
lnSuccess = loImap.QueryMbx("FROM Gencer",lnBReturnUids,loMsgSet)
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loMsgSet
    CANCEL
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
lcSequenceSet = loMsgSet.ToCompactString()
? lcSequenceSet

* Let's form our MOVE command.
loSbMoveCmd = CreateObject('Chilkat.StringBuilder')
loSbMoveCmd.Append("MOVE ")
loSbMoveCmd.Append(lcSequenceSet)
loSbMoveCmd.Append(" old/gencer")
? "Sending: " + loSbMoveCmd.GetAsString()

lcCmdResponse = loImap.SendRawCommand(loSbMoveCmd.GetAsString())
IF (loImap.LastMethodSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loMsgSet
    RELEASE loSbMoveCmd
    CANCEL
ENDIF

? lcCmdResponse

* 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.
lnSuccess = loImap.Disconnect()

? "All Done."

RELEASE loImap
RELEASE loMsgSet
RELEASE loSbMoveCmd