(PHP Extension) Scan for Emails with Attachments and Save Attachments to Files

Scan for emails with attachments and save attachments.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux

<?php

include("chilkat.php");

$success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$imap = new CkImap();

// Connect to an IMAP server.
// Use TLS
$imap->put_Ssl(true);
$imap->put_Port(993);
$success = $imap->Connect('imap.example.com');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Login
$success = $imap->Login('myLogin','myPassword');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Select an IMAP mailbox
$success = $imap->SelectMailbox('Inbox');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// We can choose to fetch UIDs or sequence numbers.
$fetchUids = true;

// Get the message IDs of all the emails in the mailbox
$messageSet = new CkMessageSet();
$success = $imap->QueryMbx('ALL',$fetchUids,$messageSet);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Fetch the email headers into a bundle object:
$bundle = new CkEmailBundle();
$headersOnly = true;
$success = $imap->FetchMsgSet($headersOnly,$messageSet,$bundle);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Scan for emails with attachments, and save the attachments
// to a sub-directory.
$fullEmail = new CkEmail();
$emailHeader = new CkEmail();
$i = 0;
while ($i < $bundle->get_MessageCount()) {
    // The bundle contains email headers..
    $bundle->EmailAt($i,$emailHeader);

    // Does this email have attachments?
    // Use GetMailNumAttach because the attachments
    // are not actually in the email object because
    // we only downloaded headers.
    $numAttach = $imap->GetMailNumAttach($emailHeader);

    if ($numAttach > 0) {
        // Download the entire email and save the
        // attachments. (Remember, we 
        // need to download the entire email because
        // only the headers were previously downloaded.

        // The ckx-imap-uid header field is added when
        // headers are downloaded.  This makes it possible
        // to get the UID from the email object.
        $uidStr = $emailHeader->getHeaderField('ckx-imap-uid');
        $uid = $uidStr;

        $success = $imap->FetchEmail(false,$uid,true,$fullEmail);
        if ($success == false) {
            print $imap->lastErrorText() . "\n";
            exit;
        }

        $success = $fullEmail->SaveAllAttachments('attachmentsDir');

        for ($j = 0; $j <= $numAttach - 1; $j++) {
            $filename = $imap->getMailAttachFilename($emailHeader,$j);
            print $filename . "\n";
        }

    }

    $i = $i + 1;
}

// Disconnect from the IMAP server.
$success = $imap->Disconnect();

?>