List IMAP Mailboxes with Reference

Demonstrates how to list all sub-mailboxes within a specified context. In this case, we list all mailboxes under "INBOX.vendors".

Download Chilkat Ruby Library

require 'chilkat'

imap = Chilkat::CkImap.new()

# Anything unlocks the component and begins a fully-functional 30-day trial.
success = imap.UnlockComponent("Anything for 30-day trial")
if (success != true)
    print imap.lastErrorText() + "\n"
    exit
end

# Connect to an IMAP server.
success = imap.Connect("mail.chilkatsoft.com")
if (success != true)
    print imap.lastErrorText() + "\n"
    exit
end

# Login
success = imap.Login("admin@chilkatsoft.com","*myPassword5*")
if (success != true)
    print imap.lastErrorText() + "\n"
    exit
end

# The ListMailboxes method returns a Mailboxes object
# that contains the collection of mailboxes.
# It accepts two arguments: a refName and a wildcardedMailbox.

# List all mailboxes under INBOX.vendors
refName = "INBOX.vendors"

# Select all mailboxes matching this pattern:
wildcardedMailbox = "*"

mboxes = imap.ListMailboxes(refName,wildcardedMailbox)
if (mboxes == nil )
    print imap.lastErrorText() + "\n"
    exit
end

for i in 0 .. mboxes.get_Count() - 1
    print mboxes.getName(i) + "\n";
end

# Sample output looks like this:
# INBOX.vendors.shareit
# INBOX.vendors.paypal
# INBOX.vendors.dell
# INBOX.vendors.inMotion
# INBOX.vendors.myhosting
# INBOX.vendors.peer1

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