Ruby

Determine the Number of Unseen Email Messages

Demonstrates how to determine how many unseen messages exist in an email account on an IMAP server. 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("***","***")
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

# After selecting the mailbox. the total number of emails
# is immediately available:
totalNum = imap.get_NumMessages()
print "Num messages = " + totalNum.to_s() + "\n";

# To determine the number of unseen messages, a call
# to Search is required, which returns the set of UIDs
# of all unseen messages.

# We can choose to fetch UIDs or sequence numbers.
fetchUids = true
messageSet = Chilkat::CkMessageSet.new()
success = imap.QueryMbx("UNSEEN",fetchUids,messageSet)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

numUnseen = messageSet.get_Count()
print numUnseen.to_s() + "\n";

print "UIDs ----" + "\n";

# Display the UIDs
i = 0
while i < messageSet.get_Count()
    print messageSet.GetId(i).to_s() + "\n";
    i = i + 1
end

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