Visual FoxPro

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 Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loImap
LOCAL lnHeadersOnly
LOCAL lnUseUid
LOCAL lnSeqNum
LOCAL loEmail
LOCAL lnNumAttach
LOCAL i
LOCAL lcFname

lnSuccess = 0

*  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.

loImap = CreateObject('Chilkat.Imap')

loImap.Ssl = 1
loImap.Port = 993

lnSuccess = loImap.Connect("imap.example.com")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

lnSuccess = loImap.Login("user@example.com","myPassword")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

lnSuccess = loImap.SelectMailbox("Inbox")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

*  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.
lnHeadersOnly = 1
lnUseUid = 0
lnSeqNum = 1
loEmail = CreateObject('Chilkat.Email')
lnSuccess = loImap.FetchEmail(lnHeadersOnly,lnSeqNum,lnUseUid,loEmail)
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loEmail
    CANCEL
ENDIF

*  Loop over the attachments and print each filename.
lnNumAttach = loImap.GetMailNumAttach(loEmail)
? "Attachments: " + STR(lnNumAttach)

FOR i = 0 TO lnNumAttach - 1
    *  GetMailAttachFilename returns a string, so assign it to a string variable.
    lcFname = loImap.GetMailAttachFilename(loEmail,i)
    IF (loImap.LastMethodSuccess = 0) THEN
        ? loImap.LastErrorText
        RELEASE loImap
        RELEASE loEmail
        CANCEL
    ENDIF

    ? lcFname
NEXT

lnSuccess = loImap.Disconnect()
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loEmail
    CANCEL
ENDIF

RELEASE loImap
RELEASE loEmail