Swift

Outlook -- Get Number of Emails

See more Outlook Examples

Gets the number of emails in an Outlook folder. This uses the OData $count system query option. See OData System Query Option $count for general information.

This example first gets the combined total number of messages across all folders.

Note: This example requires Chilkat v9.5.0.68 or greater.

This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Swift

func chilkatTest() {
    var success: Bool = false

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

    let http = CkoHttp()!

    // Use your previously obtained access token here:
    // See the following examples for getting an access token:
    //    Get Microsoft Graph OAuth2 Access Token (Azure AD v2.0 Endpoint).
    //    Get Microsoft Graph OAuth2 Access Token (Azure AD Endpoint).
    //    Refresh Access Token (Azure AD v2.0 Endpoint).
    //    Refresh Access Token (Azure AD Endpoint).

    http.authToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"

    let sbResponse = CkoStringBuilder()!

    // This gets the combined total number of emails in all folders.
    success = http.quickGetSb(url: "https://graph.microsoft.com/v1.0/me/messages/$count", sbContent: sbResponse)
    if (success != true) && (http.lastStatus.intValue == 0) {
        print("\(http.lastErrorText!)")
        return
    }

    let json = CkoJsonObject()!
    json.emitCompact = false

    // If the status code was not 200, then it failed and the response is likely JSON:
    if http.lastStatus.intValue != 200 {
        print("Status code = \(http.lastStatus.intValue)")
        json.loadSb(sb: sbResponse)
        print("\(json.emit()!)")
        print("Failed.")
        return
    }

    // A success response payload contains just the integer value (it is not JSON)
    print("Combined Total Number of Emails = \(sbResponse.getAsString()!)")
    print("--")

    // ---------------------------------------------------------------------------
    // To get the number of emails in a particular folder, we need to use the folder id.
    // 

    // In this example, we'd like to get number of messages in the folder "/Inbox/abc",
    // but we must specify the corresponding folder_id.  The best way to do this is to create
    // a local map of folderPaths-to-folderIds.
    // We'll use the map created by this example:  Create Outlook Folder Map)
    let htFolderMap = CkoHashtable()!
    let sbMap = CkoStringBuilder()!
    sbMap.loadFile(path: "qa_data/outlook/folderMap.xml", charset: "utf-8")
    htFolderMap.add(fromXmlSb: sbMap)

    // Get the ID for the "/Inbox/abc" folder:
    var folderId: String? = htFolderMap.lookupStr(key: "/Inbox/abc")
    if htFolderMap.lastMethodSuccess != true {
        print("Folder ID not found")
        return
    }

    http.setUrlVar(name: "folder_id", value: folderId)

    // Send the request get the folder information.
    // In this case we are NOT using the $count system query option.
    success = http.quickGetSb(url: "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}", sbContent: sbResponse)
    if (success != true) && (http.lastStatus.intValue == 0) {
        print("\(http.lastErrorText!)")
        return
    }

    json.loadSb(sb: sbResponse)
    print("\(json.emit()!)")
    print("--")

    if http.lastStatus.intValue != 200 {
        print("Status code = \(http.lastStatus.intValue)")
        print("Failed.")
        return
    }

    // The successful JSON response looks like this;

    // 	{
    // 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders/$entity",
    // 	  "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
    // 	  "displayName": "abc",
    // 	  "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA",
    // 	  "childFolderCount": 2,
    // 	  "unreadItemCount": 0,
    // 	  "totalItemCount": 3
    // 	}
    // 

    // Get the integer value from the JSON like this:
    var totalItemCount: Int = json.int(of: "totalItemCount").intValue
    print("totalItemCount = \(totalItemCount)")

    var childFolderCount: Int = json.int(of: "childFolderCount").intValue
    print("childFolderCount = \(childFolderCount)")

    // etc..

}