PowerBuilder

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

integer li_rc
integer li_Success
oleobject loo_Imap
string ls_Caps
integer li_BReturnUids
oleobject loo_MsgSet
string ls_SequenceSet
oleobject loo_SbMoveCmd
string ls_CmdResponse

li_Success = 0

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

loo_Imap = create oleobject
li_rc = loo_Imap.ConnectToNewObject("Chilkat.Imap")
if li_rc < 0 then
    destroy loo_Imap
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Use an implicit TLS connection.
loo_Imap.Ssl = 1
loo_Imap.Port = 993
li_Success = loo_Imap.Connect("MY-IMAP-DOMAIN")
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Authenticate
li_Success = loo_Imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Get the list of capabilities:
ls_Caps = loo_Imap.Capability()
Write-Debug "Capabilities: " + ls_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 loo_Imap.HasCapability("MOVE",ls_Caps) <> 1 then
    Write-Debug "The IMAP server does not support the MOVE extension."
    destroy loo_Imap
    return
end if

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

li_Success = loo_Imap.SelectMailbox("old")
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

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

loo_MsgSet = create oleobject
li_rc = loo_MsgSet.ConnectToNewObject("Chilkat.MessageSet")

li_Success = loo_Imap.QueryMbx("FROM Gencer",li_BReturnUids,loo_MsgSet)
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    destroy loo_MsgSet
    return
end if

// 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
ls_SequenceSet = loo_MsgSet.ToCompactString()
Write-Debug ls_SequenceSet

// Let's form our MOVE command.
loo_SbMoveCmd = create oleobject
li_rc = loo_SbMoveCmd.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbMoveCmd.Append("MOVE ")
loo_SbMoveCmd.Append(ls_SequenceSet)
loo_SbMoveCmd.Append(" old/gencer")
Write-Debug "Sending: " + loo_SbMoveCmd.GetAsString()

ls_CmdResponse = loo_Imap.SendRawCommand(loo_SbMoveCmd.GetAsString())
if loo_Imap.LastMethodSuccess = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    destroy loo_MsgSet
    destroy loo_SbMoveCmd
    return
end if

Write-Debug ls_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.
li_Success = loo_Imap.Disconnect()

Write-Debug "All Done."


destroy loo_Imap
destroy loo_MsgSet
destroy loo_SbMoveCmd