![]() |
Chilkat HOME Android™ AutoIt C C# C++ Chilkat2-Python CkPython Classic ASP DataFlex Delphi DLL Go Java Node.js Objective-C PHP Extension Perl PowerBuilder PowerShell PureBasic Ruby SQL Server Swift Tcl Unicode C Unicode C++ VB.NET VBScript Visual Basic 6.0 Visual FoxPro Xojo Plugin
(Ruby) Read IMAP Email HeadersCall FetchHeaders to download only the email headers. Note: This example requires Chilkat v11.0.0 or greater.
require 'chilkat' success = false # This example requires 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("****","****") if (success == false) print imap.lastErrorText() + "\n"; exit end # Select an IMAP mailbox success = imap.SelectMailbox("Inbox") if (success == false) print imap.lastErrorText() + "\n"; exit end # Get the message IDs of all the emails in the mailbox # We can choose to fetch UIDs or sequence numbers. fetchUids = true messageSet = Chilkat::CkMessageSet.new() success = imap.QueryMbx("ALL",fetchUids,messageSet) if (success == false) print imap.lastErrorText() + "\n"; exit end # When downloading headers, each email object contains # (obviously) the headers, but the body will be missing. # Also, attachments will not be included. However, it is # possible to get information about the attachments # as well as the complete size of the email. bundle = Chilkat::CkEmailBundle.new() headersOnly = true success = imap.FetchMsgSet(headersOnly,messageSet,bundle) if (success == false) print imap.lastErrorText() + "\n"; exit end # Loop over the email objects and display information # about each: email = Chilkat::CkEmail.new() i = 0 j = 0 while i < bundle.get_MessageCount() bundle.EmailAt(i,email) # Display the From and Subject print email.ck_from() + "\n"; print email.subject() + "\n"; # Display the recipients: j = 0 while j < email.get_NumTo() print "TO: " + email.getToName(j) + ", " + email.getToAddr(j) + "\n"; j = j + 1 end j = 0 while j < email.get_NumCC() print "CC: " + email.getCcName(j) + ", " + email.getCcAddr(j) + "\n"; j = j + 1 end # Show the total size of the email, including body and attachments: print email.get_Size().to_s() + "\n"; # When a full email is downloaded, we would use the # email.NumAttachments property in conjunction with the # email.GetMailAttach* methods. # However, when an email object contains only the header, # we need to access the attachment info differently: numAttach = imap.GetMailNumAttach(email) j = 0 while j < numAttach print imap.getMailAttachFilename(email,j) + "\n"; attachSize = imap.GetMailAttachSize(email,j) print " size = " + attachSize.to_s() + " bytes" + "\n"; j = j + 1 end print "--" + "\n"; end # Disconnect from the IMAP server. success = imap.Disconnect() |
© 2000-2025 Chilkat Software, Inc. All Rights Reserved.