(Ruby) List Yahoo Mail IMAP Mailboxes

See more Yahoo Mail Examples

List Yahoo Mail mailboxes.

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.

# See Get Yahoo Mail OAuth2 Access Token for Desktop App 
# for sample code showing how to obtain a Yahoo Mail access token.

# In this example, our access token was previously saved to the following file which contains JSON like this:
# {
#   "access_token": "kCVQdnOdul...LHucA--",
#   "refresh_token": "AIenVXETSo0jklFBVkPS8vVm8E.Ej9ToRG.xDbDYmZ65WIs5t6CZhDrD",
#   "expires_in": 3600,
#   "token_type": "bearer",
#   "xoauth_yahoo_guid": "HGDQCVF5JB4YDOWHITQJFBHCWA"
# }

json = Chilkat::CkJsonObject.new()
success = json.LoadFile("qa_data/tokens/yahooMail.json")
if (success != true)
    print "Failed to load GMail access token file." + "\n";
    exit
end

accessToken = json.stringOf("access_token")

# Do OAuth2 authentication by using the access token as the password in the Login method below...
imap = Chilkat::CkImap.new()

imap.put_Ssl(true)
imap.put_Port(993)

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

# Indicate that XOAUTH2 authentication is to be used:
imap.put_AuthMethod("XOAUTH2")

# Login
# Use the email address of the GMail account that granted authorization.
success = imap.Login("user@yahoo.com",accessToken)
if (success != true)
    print imap.lastErrorText() + "\n";
else
    print "Successfully authenticated with Yahoo IMAP using XOAUTH2!" + "\n";
end

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

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 = "*"

# 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:

# Archive
# Bulk Mail
# Draft
# Inbox
# Inbox/emailsWithAttach
# Inbox/test
# Sent
# Trash

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