Ruby

Fetch a Single Message's MIME into a StringBuilder

Demonstrates the Chilkat Imap.FetchSingleAsMimeSb method, which downloads one message's MIME into a StringBuilder. The first argument is the message id, the second (bUid) selects UID vs sequence number, and the third is the StringBuilder, which is cleared first. This example downloads a message by UID and prints the MIME length.

Background: Chilkat interprets the received MIME as UTF-8. Messages using Base64 or quoted-printable transfer encoding are safe because their encoded bytes are ASCII. Raw 8bit or binary content, or unencoded text in a charset such as ISO-8859-1 or Shift_JIS, can be misinterpreted — in those cases use FetchSingleBd to get the exact bytes.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Imap.FetchSingleAsMimeSb method, which downloads one message's MIME into a
#  StringBuilder.  The 1st argument is the message id, the 2nd (bUid) selects UID vs sequence
#  number, and the 3rd is the StringBuilder (cleared first).

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

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

#  Search for the message ids to download, returning UIDs.
wantUids = true
msgSet = Chilkat::CkMessageSet.new()
success = imap.QueryMbx("ALL",wantUids,msgSet)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

if (msgSet.get_Count() > 0)
    uid = msgSet.GetId(0)

    #  Download the message's MIME into a StringBuilder.  The id is a UID.
    useUid = true
    sbMime = Chilkat::CkStringBuilder.new()
    success = imap.FetchSingleAsMimeSb(uid,useUid,sbMime)
    if (success == false)
        print imap.lastErrorText() + "\n";
        exit
    end

    print "MIME length: " + sbMime.get_Length().to_s() + " chars" + "\n";
end

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