Sample code for 30+ languages & platforms
Lua Requires Chilkat v9.5.0.67+

Outlook -- List Mail Folders

See more Outlook Examples

Uses the Microsoft Graph API to list Outlook mail folders.

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

Chilkat Lua Downloads

Lua
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()

-- Sends:  GET /users/{id | userPrincipalName}/mailFolders
-- Note: It is also possible to use the literal string "me" for the current logged-on user.
-- For example: GET /me/mailFolders
http:clear_url_vars()
http:set_url_var("userPrincipalName", "chilkatsoft@outlook.com")
local success = http:quick_get_sb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders", sbResponse)
if (not success) and (http.last_status == 0) then
    print(http.last_error_text)
    return
end

local json = chilkat.JsonObject.new()
json:load_sb(sbResponse)
json.emit_compact = false

print("Status code = " .. http.last_status)
if http.last_status ~= 200 then
    print(json:emit())
    print("Failed.")
end

print(json:emit())
print("----")

-- In my test case, this is the result (see below)
-- Apparently, this lists folders without listing subfolders (aka child folders)
-- There's another REST API call to list child folders.

-- To iterate over the folders:
local i = 0
local numFolders = json:size_of_array("value")
while i < numFolders do
    json.i = i
    print(json:string_of("value[i].displayName"))
    i = i + 1
end

-- The output from the above loop:

--     Archive
--     Deleted Items
--     Drafts
--     Inbox
--     Junk Email
--     Outbox
--     Sent Items

-- ------------------------------------------------------------------------------------
-- The raw JSON response:

-- {
--   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('chilkatsoft%40outlook.com')/mailFolders",
--   "value": [
--     {
--       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=",
--       "displayName": "Archive",
--       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
--       "childFolderCount": 0,
--       "unreadItemCount": 0,
--       "totalItemCount": 0
--     },
--     {
--       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA",
--       "displayName": "Deleted Items",
--       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
--       "childFolderCount": 0,
--       "unreadItemCount": 0,
--       "totalItemCount": 0
--     },
--     {
--       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA",
--       "displayName": "Drafts",
--       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
--       "childFolderCount": 0,
--       "unreadItemCount": 0,
--       "totalItemCount": 0
--     },
--     {
--       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA",
--       "displayName": "Inbox",
--       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
--       "childFolderCount": 2,
--       "unreadItemCount": 0,
--       "totalItemCount": 4
--     },
--     {
--       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA",
--       "displayName": "Junk Email",
--       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
--       "childFolderCount": 0,
--       "unreadItemCount": 0,
--       "totalItemCount": 0
--     },
--     {
--       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA",
--       "displayName": "Outbox",
--       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
--       "childFolderCount": 0,
--       "unreadItemCount": 0,
--       "totalItemCount": 0
--     },
--     {
--       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA",
--       "displayName": "Sent Items",
--       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
--       "childFolderCount": 0,
--       "unreadItemCount": 0,
--       "totalItemCount": 14
--     }
--   ]
-- }
--

-- ------------------------------------------------------------------------------------------------------
-- This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
--
-- The Microsoft Graph Outlook Mail API lets you read, create, and send messages and attachments,
-- view and respond to event messages, and manage folders that are secured by Azure Active Directory
-- in Office 365. It also provides the same functionality in Microsoft accounts specifically
-- in these domains: Hotmail.com, Live.com, MSN.com, Outlook.com, and Passport.com.