Ruby

Move IMAP Messages to Another Mailbox

Demonstrates the Chilkat Imap.MoveMessages method, which moves the messages in a MessageSet to another mailbox on the server. The first argument is the MessageSet and the second is the destination folder name. This example searches for newsletter messages and moves them to the Archive mailbox.

Background: A true server-side move (the IMAP MOVE extension) is atomic and efficient: the message never leaves the server, so no download/re-upload is involved. If the server lacks the MOVE capability, the equivalent is copy-then-delete-then-expunge — Chilkat handles that fallback for you, but the destination mailbox must already exist.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Imap.MoveMessages method, which moves the messages in a MessageSet to
#  another mailbox on the server.  The 1st argument is the MessageSet and the 2nd is the
#  destination folder name.

imap = Chilkat::CkImap.new()

imap.put_Ssl(true)
imap.put_Port(993)

success = imap.Connect("imap.example.com")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

success = imap.Login("user@example.com","myPassword")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

success = imap.SelectMailbox("Inbox")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Find the messages to move (here, messages from a particular sender, by UID).
msgSet = Chilkat::CkMessageSet.new()
success = imap.QueryMbx("FROM \"newsletter@example.com\"",true,msgSet)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Move them to the "Archive" mailbox.
success = imap.MoveMessages(msgSet,"Archive")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

print "Moved " + msgSet.get_Count().to_s() + " messages to Archive." + "\n";

success = imap.Disconnect()
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end