(PowerBuilder) Outlook -- List Mail Folders

See more Outlook Examples

Uses the Microsoft Graph API to list Outlook mail folders.

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

For more information, see https://docs.microsoft.com/en-us/graph/api/user-list-mailfolders?view=graph-rest-1.0&tabs=http

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Http
oleobject loo_SbResponse
integer li_Success
oleobject loo_Json
integer i
integer li_NumFolders

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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).

loo_Http.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"

loo_SbResponse = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponse.ConnectToNewObject("Chilkat.StringBuilder")

// 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
loo_Http.ClearUrlVars()
loo_Http.SetUrlVar("userPrincipalName","chilkatsoft@outlook.com")
li_Success = loo_Http.QuickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders",loo_SbResponse)
if (li_Success <> 1) AND (loo_Http.LastStatus = 0) then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponse
    return
end if

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.LoadSb(loo_SbResponse)
loo_Json.EmitCompact = 0

Write-Debug "Status code = " + string(loo_Http.LastStatus)
if loo_Http.LastStatus <> 200 then
    Write-Debug loo_Json.Emit()
    Write-Debug "Failed."
end if

Write-Debug loo_Json.Emit()
Write-Debug "----"

// 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:
i = 0
li_NumFolders = loo_Json.SizeOfArray("value")
do while i < li_NumFolders
    loo_Json.I = i
    Write-Debug loo_Json.StringOf("value[i].displayName")
    i = i + 1
loop

// 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.


destroy loo_Http
destroy loo_SbResponse
destroy loo_Json