(Node.js) Office365 IMAP List Mailboxes

See more Office365 Examples

List the Office365 IMAP mailboxes.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // An Office365 OAuth2 access token must first be obtained prior
    // to running this code.

    // Getting the OAuth2 access token for the 1st time requires the O365 account owner's 
    // interactive authorizaition via a web browser.  Afterwards, the access token
    // can be repeatedly refreshed automatically.

    // See the following examples for getting and refreshing an OAuth2 access token

    // Get Office365 SMTP/IMAP/POP3 OAuth2 Access Token
    // Refresh Office365 SMTP/IMAP/POP3 OAuth2 Access Token

    // First get our previously obtained OAuth2 access token.
    var jsonToken = new chilkat.JsonObject();
    var success = jsonToken.LoadFile("qa_data/tokens/office365.json");
    if (success == false) {
        console.log("Failed to open the office365 OAuth JSON file.");
        return;
    }

    var imap = new chilkat.Imap();

    imap.Ssl = true;
    imap.Port = 993;

    // Connect to the Office365 IMAP server.
    success = imap.Connect("outlook.office365.com");
    if (success !== true) {
        console.log(imap.LastErrorText);
        return;
    }

    // Use OAuth2 authentication.
    imap.AuthMethod = "XOAUTH2";

    // Login using our username (i.e. email address) and the access token for the password.
    success = imap.Login("OFFICE365_EMAIL_ADDRESS",jsonToken.StringOf("access_token"));
    if (success !== true) {
        console.log(imap.LastErrorText);
        return;
    }

    console.log("O365 OAuth authentication is successful.");

    // The ListMailboxes method returns a Mailboxes object
    // that contains the collection of mailboxes.
    // It accepts two arguments: a refName and a wildcardedMailbox.

    var refName = "";
    // refName is usually set to an empty string.
    // A non-empty reference name argument is the name of a mailbox or a level of
    // mailbox hierarchy, and indicates the context in which the mailbox
    // name is interpreted.

    // Select all mailboxes matching this pattern:
    var wildcardedMailbox = "*";

    // mboxes: Mailboxes
    var mboxes = imap.ListMailboxes(refName,wildcardedMailbox);
    if (imap.LastMethodSuccess == false) {
        console.log(imap.LastErrorText);
        return;
    }

    var i = 0;
    while (i < mboxes.Count) {
        console.log(mboxes.GetName(i));
        i = i+1;
    }

    // Sample output looks like this:
    // Archive
    // Calendar
    // Calendar/Birthdays
    // Calendar/United States holidays
    // Contacts
    // Conversation History
    // Deleted Items
    // Drafts
    // INBOX
    // INBOX/abc
    // INBOX/misc
    // INBOX/misc/birdeye
    // INBOX/old
    // INBOX/old/large
    // INBOX/receipts
    // Journal
    // Junk Email
    // Notes
    // Outbox
    // RSS Subscriptions
    // Sent Items
    // Sync Issues
    // Sync Issues/Conflicts
    // Sync Issues/Local Failures
    // Sync Issues/Server Failures
    // Tasks
    // Trash

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


}

chilkatExample();