(PHP ActiveX) Get IMAP UID from Email Header

Demonstrates how to get the IMAP UID from an email header. After fetching an email or header using IMAP, the UID is contained in the ckx-imap-uid header field.

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

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Imap')
$imap = new COM("Chilkat.Imap");

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

// Login
$success = $imap->Login('login','password');
if ($success != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

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

$fetchUids = 1;
// Get the message UIDs of all the emails in the mailbox
// messageSet is a Chilkat.MessageSet
$messageSet = $imap->Search('ALL',$fetchUids);
if ($imap->LastMethodSuccess != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

// bundle is a Chilkat.EmailBundle
$bundle = $imap->FetchHeaders($messageSet);
if ($imap->LastMethodSuccess != 1) {

    print $imap->LastErrorText . "\n";
    exit;
}

// The UID of each fetched email header is available 
// in the ckx-imap-uid header field.
$i = 0;
$szBundle = $bundle->MessageCount;
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.MessageSet')
$msOneMsg = new COM("Chilkat.MessageSet");
while ($i < $szBundle) {
    // email is a Chilkat.Email
    $email = $bundle->GetEmail($i);

    // Build a message set containing one UID
    $uidStr = $email->getHeaderField('ckx-imap-uid');
    $msOneMsg->FromCompactString($uidStr);

    // Move this message to some other folder.
    $success = $imap->MoveMessages($msOneMsg,'someOtherFolder');
    if ($success != 1) {
        print $imap->LastErrorText . "\n";
        // Exit the loop...
        $i = $szBundle;
    }

    $i = $i + 1;
}

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


?>