Lua Requires Chilkat v9.5.0.68+
Lua
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.
This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
Chilkat Lua Downloads
local chilkat = require("chilkat")
-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
local http = chilkat.Http.new()
-- 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.auth_token = "MICROSOFT_GRAPH_ACCESS_TOKEN"
local sbResponse = chilkat.StringBuilder.new()
-- This gets the combined total number of emails in all folders.
local success = http:quick_get_sb("https://graph.microsoft.com/v1.0/me/messages/$count", sbResponse)
if (not success) and (http.last_status == 0) then
print(http.last_error_text)
return
end
local json = chilkat.JsonObject.new()
json.emit_compact = false
-- If the status code was not 200, then it failed and the response is likely JSON:
if http.last_status ~= 200 then
print("Status code = " .. http.last_status)
json:load_sb(sbResponse)
print(json:emit())
print("Failed.")
return
end
-- A success response payload contains just the integer value (it is not JSON)
print("Combined Total Number of Emails = " .. sbResponse:get_as_string())
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)
local htFolderMap = chilkat.Hashtable.new()
local sbMap = chilkat.StringBuilder.new()
sbMap:load_file("qa_data/outlook/folderMap.xml", "utf-8")
htFolderMap:add_from_xml_sb(sbMap)
-- Get the ID for the "/Inbox/abc" folder:
local folderId = htFolderMap:lookup_str("/Inbox/abc")
if not htFolderMap.last_method_success then
print("Folder ID not found")
return
end
http:set_url_var("folder_id", folderId)
-- Send the request get the folder information.
-- In this case we are NOT using the $count system query option.
success = http:quick_get_sb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}", sbResponse)
if (not success) and (http.last_status == 0) then
print(http.last_error_text)
return
end
json:load_sb(sbResponse)
print(json:emit())
print("--")
if http.last_status ~= 200 then
print("Status code = " .. http.last_status)
print("Failed.")
return
end
-- 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:
local totalItemCount = json:int_of("totalItemCount")
print("totalItemCount = " .. totalItemCount)
local childFolderCount = json:int_of("childFolderCount")
print("childFolderCount = " .. childFolderCount)
-- etc..