(Ruby) Subscribe to Mailboxes and List Subscribed Mailboxes

Demonstrates how to list subscribed mailboxes, and unsubscribe/subscribe to a mailbox.

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

# Login
success = imap.Login("myLogin","myPassword")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

# First examine the already subscribed mailboxes.
refName = ""
wildcardedMailbox = "*"
subscribed = true

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
print "----" + "\n";

# Sample output.

# INBOX
# INBOX/recent
# INBOX/misc
# INBOX/misc/solutions
# ...
# Outbox
# Deleted Items
# Sent Items
# Drafts
# Junk E-mail
# Trash
# Sent
# Templates

# Let's unsubscribe to "INBOX/misc/solutions".
success = imap.Unsubscribe("INBOX/misc/solutions")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

# Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
success = imap.MbxList(subscribed,"","INBOX/misc*",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
print "----" + "\n";

# Re-subscribe to "INBOX/misc/solutions".
success = imap.Subscribe("INBOX/misc/solutions")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

# Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
success = imap.MbxList(subscribed,"","INBOX/misc*",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
print "----" + "\n";

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