Chilkat2-Python

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 Chilkat2-Python Downloads

Download Chilkat for Chilkat2-Python

Chilkat2-Python

import sys
import chilkat2

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 = chilkat2.Imap()

imap.Ssl = True
imap.Port = 993

success = imap.Connect("imap.example.com")
if (success == False):
    print(imap.LastErrorText)
    sys.exit()

success = imap.Login("user@example.com","myPassword")
if (success == False):
    print(imap.LastErrorText)
    sys.exit()

success = imap.SelectMailbox("Inbox")
if (success == False):
    print(imap.LastErrorText)
    sys.exit()

# 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 = chilkat2.Email()
success = imap.FetchEmail(headersOnly,seqNum,useUid,email)
if (success == False):
    print(imap.LastErrorText)
    sys.exit()

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

for i in range(0,numAttach):
    # GetMailAttachFilename returns a string, so assign it to a string variable.
    fname = imap.GetMailAttachFilename(email,i)
    if (imap.LastMethodSuccess == False):
        print(imap.LastErrorText)
        sys.exit()

    print(fname)

success = imap.Disconnect()
if (success == False):
    print(imap.LastErrorText)
    sys.exit()