(PHP ActiveX) Fetch Full Email Given Email Header

When you fetch email headers using UIDs instead of sequence numbers, the email object (which includes only the header) will have auto-generated ckx-imap-* headers. These headers provide details like the UID and attachments. The IMAP UID is found in the ckx-imap-uid header. Additionally, the ckx-imap-isUid header indicates whether the email header was downloaded by UID, showing YES or NO. Since sequence numbers can change if emails are deleted, UIDs are essential for downloading the correct full email.

The Chilkat Email object offers a GetImapUid method to retrieve the UID from the ckx-imap-uid header. This UID can be used to fetch the full email.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

$success = 0;

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

$imap = new COM("Chilkat.Imap");

// Connect to an IMAP server.
// Use TLS
$imap->Ssl = 1;
$imap->Port = 993;
$success = $imap->Connect('imap.example.com');
if ($success == 0) {
    print $imap->LastErrorText . "\n";
    exit;
}

// Login
$success = $imap->Login('***','***');
if ($success == 0) {
    print $imap->LastErrorText . "\n";
    exit;
}

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

$emailHeader = new COM("Chilkat.Email");
$emailFull = new COM("Chilkat.Email");

$uid = 2014;
$isUid = 1;

// Fetch only the email header
$success = $imap->FetchEmail(1,$uid,$isUid,$emailHeader);
if ($success == 0) {
    print $imap->LastErrorText . "\n";
    exit;
}

// Now fetch the full email
$uidFromCkxHeader = $emailHeader->GetImapUid();
if ($uidFromCkxHeader < 0) {
    // Failed. 
    print 'No ckx-imap-uid header was found.' . "\n";
    exit;
}

$success = $imap->FetchEmail(0,$uid,$isUid,$emailFull);
if ($success == 0) {
    print $imap->LastErrorText . "\n";
    exit;
}

// OK, we have the full email, do whatever we want...

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

?>