(Ruby) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Note: This example requires Chilkat v11.0.0 or greater.

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

require 'chilkat'

success = false

# 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("MY-IMAP-DOMAIN")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

# Login
success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

refName = ""
# refName is usually set to an empty string.
# A non-empty reference name argument is the name of a mailbox or a level of
# mailbox hierarchy, and indicates the context in which the mailbox
# name is interpreted.

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

subscribed = false

mboxes = Chilkat::CkMailboxes.new()
success = imap.MbxList(subscribed,refName,wildcardedMailbox,mboxes)
if (success == 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.oldSupport
# INBOX.vendors.paypal
# INBOX.sales
# INBOX.lists
# INBOX.Drafts
# INBOX.vendors.dell
# INBOX.Trash
# INBOX.invoiceRequests
# INBOX.purchases
# INBOX.vendors.inMotion
# INBOX.oldEmail
# INBOX.vendors
# INBOX.lists.python
# INBOX.vendors.myhosting
# INBOX.Templates
# INBOX.friends
# INBOX.bounceSamples
# INBOX.lists.ruby
# INBOX.vendors.peer1
# INBOX.Sent
# INBOX.Junk
# INBOX

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