(Swift 3,4,5...) Office365 IMAP List Mailboxes

See more Office365 Examples

List the Office365 IMAP mailboxes.

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // 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.
    let jsonToken = CkoJsonObject()!
    var success: Bool = jsonToken.loadFile("qa_data/tokens/office365.json")
    if success == false {
        print("Failed to open the office365 OAuth JSON file.")
        return
    }

    let imap = CkoImap()!

    imap.ssl = true
    imap.port = 993

    // Connect to the Office365 IMAP server.
    success = imap.connect("outlook.office365.com")
    if success != true {
        print("\(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", password: jsonToken.string(of: "access_token"))
    if success != true {
        print("\(imap.lastErrorText!)")
        return
    }

    print("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: String? = ""
    // 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: String? = "*"

    var mboxes: CkoMailboxes? = imap.listMailboxes(refName, wildcardedMailbox: wildcardedMailbox)
    if imap.lastMethodSuccess == false {
        print("\(imap.lastErrorText!)")
        return
    }

    var i: Int = 0
    while i < mboxes!.count.intValue {
        print("\(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()

    mboxes = nil

}