Ruby

IMAP Capability

Demonstrates how to send the CAPABILITY command to request a listing of capabilities that the IMAP server supports. A capability name which begins with "AUTH=" indicates that the server supports that particular authentication mechanism. Ruby

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()

# Use TLS
imap.put_Ssl(true)
imap.put_Port(993)
success = imap.Connect("MY-IMAP-DOMAIN")
if (success != true)
    print imap.lastErrorText() + "\n";
    exit
end

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

# Get the list of capabilities:
caps = imap.capability()
print "Capabilities: " + caps + "\n";

# Here is an example of the string returned:
# * CAPABILITY IMAP4rev1 UNSELECT IDLE NAMESPACE QUOTA ID XLIST CHILDREN X-GM-EXT-1 
# UIDPLUS COMPRESS=DEFLATE ENABLE MOVE CONDSTORE ESEARCH UTF8=ACCEPT APPENDLIMIT=35882577
# LIST-EXTENDED LIST-STATUS

# Chilkat v9.5.0.58 introduces the HasCapability method to
# check to see if a particular capability exists:
if (imap.HasCapability("QUOTA",caps) == true)
    print "IMAP server supports the QUOTA extension." + "\n";
end

if (imap.HasCapability("IDLE",caps) == true)
    print "IMAP server supports IDLE." + "\n";
end

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