(Ruby) Transition from Imap.ListSubscribed to Imap.MbxList

Provides instructions for replacing deprecated ListSubscribed method calls with MbxList.

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'

imap = Chilkat::CkImap.new()

# ...
# ...

reference = ""
mbxPattern = "*"

# ------------------------------------------------------------------------
# The ListSubscribed method is deprecated:

# Lists only subscribed mailboxes.
# mboxesObj is a CkMailboxes
mboxesObj = imap.ListSubscribed(reference,mbxPattern)
if (imap.get_LastMethodSuccess() == false)
    print imap.lastErrorText() + "\n";
    exit
end

# ...
# ...

# ------------------------------------------------------------------------
# Do the equivalent using MbxList.
# Your application creates a new, empty Mailboxes object which is passed 
# in the last argument and filled upon success.

# Lists only subscribed mailboxes.
subscribed = true

mboxes = Chilkat::CkMailboxes.new()
success = imap.MbxList(subscribed,reference,mbxPattern,mboxes)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end