(Ruby) 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".

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

require 'chilkat'

# This example assumes 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("admin@chilkatsoft.com","myPassword")
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 is a CkMailboxes
mboxes = imap.ListMailboxes(refName,wildcardedMailbox)
if (imap.get_LastMethodSuccess() == false)
    print imap.lastErrorText() + "\n";
    exit
end

i = 0
while i < mboxes.get_Count()
    print mboxes.getName(i) + "\n";
    i = i + 1
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.
success = imap.Disconnect()