(PHP Extension) Move Messages from one Mailbox to Another

If your IMAP server supports the MOVE capability, then it is possible to move messages from one mailbox (folder) to another. This example demonstrates the MOVE command using the SendRawCommand method. The IMAP MOVE Extension is documented in RFC 6851.

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 assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$imap = new CkImap();

// Use an implicit TLS connection.
$imap->put_Ssl(true);
$imap->put_Port(993);
$success = $imap->Connect('MY-IMAP-DOMAIN');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Authenticate
$success = $imap->Login('MY-IMAP-LOGIN','MY-IMAP-PASSWORD');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Get the list of capabilities:
$caps = $imap->capability();
print 'Capabilities: ' . $caps . "\n";

// Here is an example of the string returned:
// * CAPABILITY IMAP4rev1 UNSELECT IDLE NAMESPACE QUOTA ID XLIST CHILDREN X-GM-EXT-1 
// UIDPLUS COMPRESS=DEFLATE ENABLE MOVE CONDSTORE ESEARCH UTF8=ACCEPT APPENDLIMIT=35882577
// LIST-EXTENDED LIST-STATUS

if ($imap->HasCapability('MOVE',$caps) != true) {
    print 'The IMAP server does not support the MOVE extension.' . "\n";
    exit;
}

print 'Good, the MOVE extension is supported...' . "\n";

// Select a mailbox, search for some messages to get a sequence-set (i.e. a 
// range of message sequence numbers or UIDs.  Then move these messages to another
// mailbox.

$success = $imap->SelectMailbox('old');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Get a set of message sequence numbers for all emails with "Gencer" in the FROM name/address.
$bReturnUids = false;
// msgSet is a CkMessageSet
$msgSet = $imap->Search('FROM Gencer',$bReturnUids);
if ($imap->get_LastMethodSuccess() != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// The message set, as a compact string, will look something like this:
// 1572,1876:1881,1883,1886,1895,1905:1906,1910:1911,1923,1959:1963
$sequenceSet = $msgSet->toCompactString();
print $sequenceSet . "\n";

// Let's form our MOVE command.
$sbMoveCmd = new CkStringBuilder();
$sbMoveCmd->Append('MOVE ');
$sbMoveCmd->Append($sequenceSet);
$sbMoveCmd->Append(' old/gencer');
print 'Sending: ' . $sbMoveCmd->getAsString() . "\n";

$cmdResponse = $imap->sendRawCommand($sbMoveCmd->getAsString());
if ($imap->get_LastMethodSuccess() != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

print $cmdResponse . "\n";

// The response looks like this:
// 	* 1572 EXPUNGE
// 	* 1875 EXPUNGE
// 	* 1875 EXPUNGE
// 	* 1875 EXPUNGE
// 	* 1875 EXPUNGE
// 	* 1875 EXPUNGE
// 	* 1875 EXPUNGE
// 	* 1876 EXPUNGE
// 	* 1878 EXPUNGE
// 	* 1886 EXPUNGE
// 	* 1895 EXPUNGE
// 	* 1895 EXPUNGE
// 	* 1898 EXPUNGE
// 	* 1898 EXPUNGE
// 	* 1909 EXPUNGE
// 	* 1944 EXPUNGE
// 	* 1944 EXPUNGE
// 	* 1944 EXPUNGE
// 	* 1944 EXPUNGE
// 	* 1944 EXPUNGE
// 	* 2274 EXISTS
// 	aaaf OK [COPYUID 62 1582,1886:1891,1893,1896,1905,1915:1916,1920:1921,1933,1974:1978 20,17,16,15,14,13,12,10:11,9,19,18,8,7,6,5,4,3,2,1] (Success)

// The last line should indicate OK.
// Note: Starting in Chilkat v9.5.0.62, the Chilkat will add a MoveMessages method to make this easier.
// Until then, or if using an older version of Chilkat, the response will need to be parsed for "OK" or "BAD".

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

print 'All Done.' . "\n";

?>