Ruby

Get IMAP UID from Email Header

See more IMAP Examples

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. 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("login","password")
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

fetchUids = true
# Get the message UIDs of all the emails in the mailbox

messageSet = Chilkat::CkMessageSet.new()
success = imap.QueryMbx("ALL",fetchUids,messageSet)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

bundle = Chilkat::CkEmailBundle.new()
headersOnly = true
success = imap.FetchMsgSet(headersOnly,messageSet,bundle)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

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

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

    # Move this message to some other folder.
    success = imap.MoveMessages(msgSet1,"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()