(Swift 3,4,5...) Examine Yahoo Mail IMAP Session Log

See more Yahoo Mail Examples

To examine the IMAP session log, set the KeepSessionLog property = true, and then examine the contents of the SessionLog property.

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

func chilkatTest() {
    // 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"
    // }

    let json = CkoJsonObject()!
    var success: Bool = json.loadFile("qa_data/tokens/yahooMail.json")
    if success != true {
        print("Failed to load Yahoo Mail access token file.")
        return
    }

    var accessToken: String? = json.string(of: "access_token")

    // Do OAuth2 authentication by using the access token as the password in the Login method below...
    let imap = CkoImap()!

    imap.ssl = true
    imap.port = 993

    // Tell Chilkat IMAP to keep a session log.
    imap.keepSessionLog = true

    // Connect to the Yahoo IMAP server.
    success = imap.connect("imap.mail.yahoo.com")
    if success != true {
        print("\(imap.lastErrorText!)")
        return
    }

    // Indicate that XOAUTH2 authentication is to be used:
    imap.authMethod = "XOAUTH2"

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

    // 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
    // Bulk Mail
    // Draft
    // Inbox
    // Inbox/emailsWithAttach
    // Inbox/test
    // Sent
    // Trash

    // Examine the session log
    print("\(imap.sessionLog!)")

    // Sample session log

    // ----INFO----
    // Connecting to IMAP server at imap.mail.yahoo.com:993
    // ----IMAP RESPONSE----
    // * OK [CAPABILITY IMAP4rev1 SASL-IR AUTH=PLAIN AUTH=XOAUTH2 AUTH=OAUTHBEARER ID MOVE NAMESPACE XYMHIGHESTMODSEQ UIDPLUS LITERAL+ CHILDREN X-MSG-EXT OBJECTID] IMAP4rev1 Hello
    // ----IMAP REQUEST----
    // aaab AUTHENTICATE XOAUTH2 
    // ----IMAP RESPONSE----
    // aaab OK AUTHENTICATE completed
    // ----IMAP REQUEST----
    // aaac LIST "" "*"
    // ----IMAP RESPONSE----
    // * LIST (\Archive \HasNoChildren) "/" "Archive"
    // * LIST (\Junk \HasNoChildren) "/" "Bulk Mail"
    // * LIST (\Drafts \HasNoChildren) "/" "Draft"
    // * LIST (\HasChildren) "/" "Inbox"
    // * LIST (\HasNoChildren) "/" "Inbox/emailsWithAttach"
    // * LIST (\HasNoChildren) "/" "Inbox/test"
    // * LIST (\Sent \HasNoChildren) "/" "Sent"
    // * LIST (\Trash \HasNoChildren) "/" "Trash"
    // aaac OK LIST completed

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

    mboxes = nil

}