Ruby

Subscribe to an IMAP Mailbox

Demonstrates the Chilkat Imap.Subscribe method, which subscribes the authenticated IMAP account to a mailbox. Subscription controls which mailboxes are returned by subscribed-mailbox listings. This example subscribes to a mailbox.

Background: An account can have many mailboxes, but a user often cares about only some of them. IMAP's subscription list is that curated set: mail clients typically show subscribed folders by default and hide the rest. Subscribing does not create or change a mailbox — it only adds it to the "show me this one" list (retrieved with a subscribed-only listing). Unsubscribe removes it from that list.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Imap.Subscribe method, which subscribes the authenticated IMAP account to
#  a mailbox.  Subscription controls which mailboxes are returned by subscribed-mailbox
#  listings.

imap = Chilkat::CkImap.new()

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

success = imap.Connect("imap.example.com")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

success = imap.Login("user@example.com","myPassword")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Subscribe to a mailbox.
success = imap.Subscribe("Archive2026")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

print "Subscribed to the mailbox." + "\n";

success = imap.Disconnect()
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end