(PHP Extension) List Yahoo Mail IMAP Mailboxes

See more Yahoo Mail Examples

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");

$success = false;

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

// See Get Yahoo Mail OAuth2 Access Token for Desktop App 
// for sample code showing how to obtain a Yahoo Mail access token.

// In this example, our access token was previously saved to the following file which contains JSON like this:
// {
//   "access_token": "kCVQdnOdul...LHucA--",
//   "refresh_token": "AIenVXETSo0jklFBVkPS8vVm8E.Ej9ToRG.xDbDYmZ65WIs5t6CZhDrD",
//   "expires_in": 3600,
//   "token_type": "bearer",
//   "xoauth_yahoo_guid": "HGDQCVF5JB4YDOWHITQJFBHCWA"
// }

$json = new CkJsonObject();
$success = $json->LoadFile('qa_data/tokens/yahooMail.json');
if ($success != true) {
    print 'Failed to load Yahoo Mail access token file.' . "\n";
    exit;
}

$accessToken = $json->stringOf('access_token');

// Do OAuth2 authentication by using the access token as the password in the Login method below...
$imap = new CkImap();

$imap->put_Ssl(true);
$imap->put_Port(993);

// Connect to the Yahoo IMAP server.
$success = $imap->Connect('imap.mail.yahoo.com');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Indicate that XOAUTH2 authentication is to be used:
$imap->put_AuthMethod('XOAUTH2');

// Login
// Use the email address of the Yahoo Mail account that granted authorization.
$success = $imap->Login('user@yahoo.com',$accessToken);
if ($success != true) {
    print $imap->lastErrorText() . "\n";
}
else {
    print 'Successfully authenticated with Yahoo IMAP using XOAUTH2!' . "\n";
}

// Get the list of mailboxes.
$refName = '';
$wildcardedMailbox = '*';
$subscribed = false;

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

$i = 0;
while ($i < $mboxes->get_Count()) {
    print $mboxes->getName($i) . "\n";
    $i = $i + 1;
}

// Sample output looks like this:

// Archive
// Bulk Mail
// Draft
// Inbox
// Inbox/emailsWithAttach
// Inbox/test
// Sent
// Trash

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

?>