AutoIt

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 AutoIt Downloads

Download Chilkat for AutoIt

AutoIt

Local $bSuccess = 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.

$oImap = ObjCreate("Chilkat.Imap")

$oImap.Ssl = True
$oImap.Port = 993

$bSuccess = $oImap.Connect("imap.example.com")
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oImap.Login("user@example.com","myPassword")
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oImap.SelectMailbox("Inbox")
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
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.
Local $bHeadersOnly = True
Local $bUseUid = False
Local $iSeqNum = 1
$oEmail = ObjCreate("Chilkat.Email")
$bSuccess = $oImap.FetchEmail($bHeadersOnly,$iSeqNum,$bUseUid,$oEmail)
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf

;  Loop over the attachments and print each filename.
Local $iNumAttach = $oImap.GetMailNumAttach($oEmail)
ConsoleWrite("Attachments: " & $iNumAttach & @CRLF)
Local $i
For $i = 0 To $iNumAttach - 1
    ;  GetMailAttachFilename returns a string, so assign it to a string variable.
Local $sFname = $oImap.GetMailAttachFilename($oEmail,$i)
    If ($oImap.LastMethodSuccess = False) Then
        ConsoleWrite($oImap.LastErrorText & @CRLF)
        Exit
    EndIf

    ConsoleWrite($sFname & @CRLF)
Next

$bSuccess = $oImap.Disconnect()
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf