(Tcl) 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.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set imap [new_CkImap]

# Use an implicit TLS connection.
CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993
set success [CkImap_Connect $imap "MY-IMAP-DOMAIN"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Authenticate
set success [CkImap_Login $imap "MY-IMAP-LOGIN" "MY-IMAP-PASSWORD"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Get the list of capabilities:
set caps [CkImap_capability $imap]
puts "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_HasCapability $imap "MOVE" $caps] != 1} then {
    puts "The IMAP server does not support the MOVE extension."
    delete_CkImap $imap
    exit
}

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

set success [CkImap_SelectMailbox $imap "old"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Get a set of message sequence numbers for all emails with "Gencer" in the FROM name/address.
set bReturnUids 0
# msgSet is a CkMessageSet
set msgSet [CkImap_Search $imap "FROM Gencer" $bReturnUids]
if {[CkImap_get_LastMethodSuccess $imap] != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# 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
set sequenceSet [CkMessageSet_toCompactString $msgSet]
puts "$sequenceSet"

# Let's form our MOVE command.
set sbMoveCmd [new_CkStringBuilder]

CkStringBuilder_Append $sbMoveCmd "MOVE "
CkStringBuilder_Append $sbMoveCmd $sequenceSet
CkStringBuilder_Append $sbMoveCmd " old/gencer"
puts "Sending: [CkStringBuilder_getAsString $sbMoveCmd]"

set cmdResponse [CkImap_sendRawCommand $imap [CkStringBuilder_getAsString $sbMoveCmd]]
if {[CkImap_get_LastMethodSuccess $imap] != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkStringBuilder $sbMoveCmd
    exit
}

puts "$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.
# Note: Starting in Chilkat v9.5.0.62, the Chilkat will add a MoveMessages method to make this easier.
# Until then, or if using an older version of Chilkat, the response will need to be parsed for "OK" or "BAD".

delete_CkMessageSet $msgSet

# Disconnect from the IMAP server.
set success [CkImap_Disconnect $imap]

puts "All Done."

delete_CkImap $imap
delete_CkStringBuilder $sbMoveCmd