Ruby Requires Chilkat v11.0.0+

Move Selected Emails to another Mailbox Folder

See more IMAP Examples

Downloads emails one by one in a selected mailbox, decides which emails are to be moved, and then moves the set of messages to another mailbox folder. Ruby

require 'chilkat'

success = false

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

imap = Chilkat::CkImap.new()

#  Connect to an IMAP server.
#  Use TLS
imap.put_Ssl(true)
imap.put_Port(993)
success = imap.Connect("imap.example.com")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Login
success = imap.Login("myLogin","myPassword")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Normally, when an email is downloaded, its "Seen" flag is automatically set.
#  We don't want our program to be interfering with the "Seen" flags.
#  To do this, set the PeekMode to true.
imap.put_PeekMode(true)

#  After selecting the mailbox, the NumMessages property
#  will contain the number of emails in the mailbox.
#  When sequence numbers (not UIDs) are used to reference emails,
#  they range from 1 to N, where N is the number of messages in the mailbox.
#  This example will download the headers by sequence numbers.
numEmails = imap.get_NumMessages()

mset = Chilkat::CkMessageSet.new()

#  Indicate that mset contains sequence numbers, not UIDs.
mset.put_HasUids(false)

#  Fetch each email and decide for each if it is to be moved
#  to a particular other mailbox.  If so, we'll add the sequence number to
#  the mset, and then move all emails in the mset to the other mailbox.
email = Chilkat::CkEmail.new()
i = 0
while i < numEmails
    #  Fetch the email by sequence number.
    success = imap.FetchEmail(false,i + 1,false,email)
    if (success == false)
        print imap.lastErrorText() + "\n";
        exit
    end

    #  If it is decided to move the email, add the sequence number to mset, like this:
    mset.InsertId(i + 1)

end

#  If there are emails in mset to be moved, then do it..
if (mset.get_Count() > 0)
    destFolder = "Inbox/SomeOtherFolder"
    #  Assuming your IMAP server supports the feature that allows for messages to be moved to another folder...
    success = imap.MoveMessages(mset,destFolder)
    if (success == false)
        print imap.lastErrorText() + "\n";
        exit
    end

end

#  Disconnect from the IMAP server.
success = imap.Disconnect()