Perl

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

Download Chilkat for Perl

Perl

use chilkat();

$success = 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.

$imap = chilkat::CkImap->new();

$imap->put_Ssl(1);
$imap->put_Port(993);

$success = $imap->Connect("imap.example.com");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

$success = $imap->Login('user@example.com',"myPassword");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

$success = $imap->SelectMailbox("Inbox");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    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 = 1;
$useUid = 0;
$seqNum = 1;
$email = chilkat::CkEmail->new();
$success = $imap->FetchEmail($headersOnly,$seqNum,$useUid,$email);
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

#  Loop over the attachments and print each filename.
$numAttach = $imap->GetMailNumAttach($email);
print "Attachments: " . $numAttach . "\r\n";

for ($i = 0; $i <= $numAttach - 1; $i++) {
    #  GetMailAttachFilename returns a string, so assign it to a string variable.
    $fname = $imap->getMailAttachFilename($email,$i);
    if ($imap->get_LastMethodSuccess() == 0) {
        print $imap->lastErrorText() . "\r\n";
        exit;
    }

    print $fname . "\r\n";
}

$success = $imap->Disconnect();
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}