Ruby Requires Chilkat v11.0.0+

Process New Email by Scanning for Senders

Scan email and save application-selected emails to EML files with unique filenames. 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()

#  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("myLogin","myPassword")
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

#  We can choose to fetch UIDs or sequence numbers.
fetchUids = true

#  Fetch messages from the mailbox using a search criteria.
#  This example finds NEW emails: these are emails that have the RECENT flag set, but not the SEEN flag:
messageSet = Chilkat::CkMessageSet.new()
success = imap.QueryMbx("NEW",fetchUids,messageSet)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  This example will download headers, and then download
#  the full email for those emails sent from a contact
#  in our database.

#  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...
emailHeader = Chilkat::CkEmail.new()
fullEmail = Chilkat::CkEmail.new()
i = 0
numEmails = bundle.get_MessageCount()
while i < numEmails
    bundle.EmailAt(i,emailHeader)

    #  The sender's email address and name are available
    #  in the From, FromAddress, and FromName properties.
    #  If the sender is "Chilkat Support <support@chilkatsoft.com",
    #  then the From property will hold the entire string.
    #  the FromName property contains"Chilkat Support",
    #  and the FromAddress property contains "support@chilkatsoft.com";
    print emailHeader.ck_from() + "\n";
    print emailHeader.fromAddress() + "\n";
    print emailHeader.fromName() + "\n";

    #  Assume at this point your code checks to see if the sender
    #  is one in your contacts database.  If so, this is
    #  the code you would write to download the entire
    #  email and save it to a file.

    #  The ckx-imap-uid header field is added when
    #  headers are downloaded.  This makes it possible
    #  to get the UID from the email object.
    uidStr = emailHeader.getHeaderField("ckx-imap-uid")
    uid = uidStr.to_i()

    success = imap.FetchEmail(false,uid,true,fullEmail)
    if (success == false)
        print imap.lastErrorText() + "\n";
        exit
    end

    #  You can use the GenerateFilename method to
    #  generate a unique filename...
    filename = fullEmail.generateFilename()

    #  SaveEml saves the entire email, including attachments.
    success = fullEmail.SaveEml(filename)

    print "--" + "\n";

    i = i + 1
end

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