(Ruby) Get IMAP UID from Email Header

Demonstrates how to get the IMAP UID from an email header. After fetching an email or header using IMAP, the UID is contained in the ckx-imap-uid header field.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# 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.someMailServer.com")
if (success != true)
    print imap.lastErrorText() + "\n";
    exit
end

# Login
success = imap.Login("login","password")
if (success != true)
    print imap.lastErrorText() + "\n";
    exit
end

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

fetchUids = true
# Get the message UIDs of all the emails in the mailbox
# messageSet is a CkMessageSet
messageSet = imap.Search("ALL",fetchUids)
if (imap.get_LastMethodSuccess() != true)
    print imap.lastErrorText() + "\n";
    exit
end

# bundle is a CkEmailBundle
bundle = imap.FetchHeaders(messageSet)
if (imap.get_LastMethodSuccess() != true)

    print imap.lastErrorText() + "\n";
    exit
end

# The UID of each fetched email header is available 
# in the ckx-imap-uid header field.
i = 0
szBundle = bundle.get_MessageCount()
msOneMsg = Chilkat::CkMessageSet.new()
while i < szBundle
    # email is a CkEmail
    email = bundle.GetEmail(i)

    # Build a message set containing one UID
    uidStr = email.getHeaderField("ckx-imap-uid")
    msOneMsg.FromCompactString(uidStr)

    # Move this message to some other folder.
    success = imap.MoveMessages(msOneMsg,"someOtherFolder")
    if (success != true)
        print imap.lastErrorText() + "\n";
        # Exit the loop...
        i = szBundle
    end

    i = i + 1
end

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