(PHP Extension) Transition from Imap.ListSubscribed to Imap.MbxList

Provides instructions for replacing deprecated ListSubscribed method calls with MbxList.

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

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

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

$imap = new CkImap();

// ...
// ...

$reference = '';
$mbxPattern = '*';

// ------------------------------------------------------------------------
// The ListSubscribed method is deprecated:

// Lists only subscribed mailboxes.
// mboxesObj is a CkMailboxes
$mboxesObj = $imap->ListSubscribed($reference,$mbxPattern);
if ($imap->get_LastMethodSuccess() == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// ...
// ...

// ------------------------------------------------------------------------
// Do the equivalent using MbxList.
// Your application creates a new, empty Mailboxes object which is passed 
// in the last argument and filled upon success.

// Lists only subscribed mailboxes.
$subscribed = true;

$mboxes = new CkMailboxes();
$success = $imap->MbxList($subscribed,$reference,$mbxPattern,$mboxes);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}


?>