PHP Requires Chilkat v11.0.0+

Move Selected Emails to another Mailbox Folder

See more IMAP Examples

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. Chilkat2 PHP

<?php

use Chilkat2\Email;
use Chilkat2\Imap;
use Chilkat2\MessageSet;

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

$imap = new Imap();

// Connect to an IMAP server.
// Use TLS
$imap->Ssl = true;
$imap->Port = 993;
try {
    $imap->Connect('imap.example.com');

    // Login
    $imap->Login('myLogin', 'myPassword');

    // Select an IMAP mailbox
    $imap->SelectMailbox('Inbox');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\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->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->NumMessages;

$mset = new MessageSet();

// Indicate that mset contains sequence numbers, not UIDs.
$mset->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.
$email = new Email();
$i = 0;
while ($i < $numEmails) {
    // Fetch the email by sequence number.
    try {
        $imap->FetchEmail(false, $i + 1, false, $email);
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\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->Count > 0) {
    $destFolder = 'Inbox/SomeOtherFolder';
    // Assuming your IMAP server supports the feature that allows for messages to be moved to another folder...
    try {
        $imap->MoveMessages($mset, $destFolder);
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
        exit;
    }
}

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