Ruby

Copy Multiple IMAP Messages to Another Mailbox

Demonstrates the Chilkat Imap.CopyMultiple method, which copies the messages in a MessageSet to another mailbox, leaving the originals in place. The first argument is the MessageSet and the second is the destination mailbox name. This example searches for recent messages and copies them to a Backup mailbox.

Background: This maps to the IMAP COPY command, which duplicates messages entirely on the server — nothing is downloaded. The copy in the destination mailbox is an independent message with its own UID; changing flags on one copy does not affect the other. Combine CopyMultiple with a search from QueryMbx to snapshot or archive matching messages without removing them from their current folder.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Imap.CopyMultiple method, which copies the messages in a MessageSet to
#  another mailbox, leaving the originals in place.  The 1st argument is the MessageSet and
#  the 2nd is the destination mailbox 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 copy (here, messages seen today, by UID).
msgSet = Chilkat::CkMessageSet.new()
success = imap.QueryMbx("SINCE 15-Jul-2026",true,msgSet)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Copy them to the "Backup" mailbox.  The originals remain in the Inbox.
success = imap.CopyMultiple(msgSet,"Backup")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

print "Copied " + msgSet.get_Count().to_s() + " messages to Backup." + "\n";

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