(PHP Extension) Move Selected Emails to another Mailbox Folder

Downloads emails one by one in a selected mailbox, decides which emails are to be moved, and then moves the set of messages to another mailbox folder.

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

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// 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.someMailServer.com');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

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

// Normally, when an email is downloaded, its "Seen" flag is automatically set.
// We don't want our program to be interfering with the "Seen" flags.
// To do this, set the PeekMode to true.
$imap->put_PeekMode(true);

// After selecting the mailbox, the NumMessages property
// will contain the number of emails in the mailbox.
// When sequence numbers (not UIDs) are used to reference emails,
// they range from 1 to N, where N is the number of messages in the mailbox.
// This example will download the headers by sequence numbers.
$numEmails = $imap->get_NumMessages();

$mset = new CkMessageSet();

// Indicate that mset contains sequence numbers, not UIDs.
$mset->put_HasUids(false);

// Fetch each email and decide for each if it is to be moved
// to a particular other mailbox.  If so, we'll add the sequence number to
// the mset, and then move all emails in the mset to the other mailbox.
$i = 0;
while ($i < $numEmails) {
    // Fetch the email by sequence number.
    // email is a CkEmail
    $email = $imap->FetchSingle($i + 1,false);
    if ($imap->get_LastMethodSuccess() != true) {
        print $imap->lastErrorText() . "\n";
        exit;
    }

    // If it is decided to move the email, add the sequence number to mset, like this:
    $mset->InsertId($i + 1);

}

// If there are emails in mset to be moved, then do it..
if ($mset->get_Count() > 0) {
    $destFolder = 'Inbox/SomeOtherFolder';
    // Assuming your IMAP server supports the feature that allows for messages to be moved to another folder...
    $success = $imap->MoveMessages($mset,$destFolder);
    if ($success != true) {
        print $imap->lastErrorText() . "\n";
        exit;
    }

}

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

?>