Ruby

Get IMAP Attachment Filenames

Demonstrates the Chilkat Imap.GetMailAttachFilename method, which returns the filename of an attachment. The first argument is the Email and the second is the zero-based attachment index. This example fetches only the message headers and lists the attachment filenames.

Background: This method reads the filename from ckx-imap-* metadata, so it works on a header-only email even though the attachment bodies have not been downloaded. That is exactly what a mail client needs to render the paperclip list — the names of the attached files — before the user decides to download any of them.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Imap.GetMailAttachFilename method, which returns the filename of an
#  attachment.  The 1st argument is the Email and the 2nd is the zero-based attachment index.

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

#  Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
#  metadata describing the attachments is present, so the attachment info methods still work.
headersOnly = true
useUid = false
seqNum = 1
email = Chilkat::CkEmail.new()
success = imap.FetchEmail(headersOnly,seqNum,useUid,email)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Loop over the attachments and print each filename.
numAttach = imap.GetMailNumAttach(email)
print "Attachments: " + numAttach.to_s() + "\n";

for i in 0 .. numAttach - 1
    #  GetMailAttachFilename returns a string, so assign it to a string variable.
    fname = imap.getMailAttachFilename(email,i)
    if (imap.get_LastMethodSuccess() == false)
        print imap.lastErrorText() + "\n";
        exit
    end

    print fname + "\n";
end

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