(C) 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 C/C++ Library Downloads

MS Visual C/C++

Linux/CentOS C/C++

Alpine Linux C/C++

MAC OS X C/C++

armhf/aarch64 C/C++

C++ Builder

iOS C/C++

Android C/C++

Solaris C/C++

MinGW C/C++

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    HCkStringBuilder sbResponse;
    BOOL success;
    HCkJsonObject json;
    int i;
    int numFolders;

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

    http = CkHttp_Create();

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

    CkHttp_putAuthToken(http,"MICROSOFT_GRAPH_ACCESS_TOKEN");

    sbResponse = CkStringBuilder_Create();

    // 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
    CkHttp_ClearUrlVars(http);
    CkHttp_SetUrlVar(http,"userPrincipalName","chilkatsoft@outlook.com");
    success = CkHttp_QuickGetSb(http,"https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders",sbResponse);
    if ((success != TRUE) && (CkHttp_getLastStatus(http) == 0)) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponse);
        return;
    }

    json = CkJsonObject_Create();
    CkJsonObject_LoadSb(json,sbResponse);
    CkJsonObject_putEmitCompact(json,FALSE);

    printf("Status code = %d\n",CkHttp_getLastStatus(http));
    if (CkHttp_getLastStatus(http) != 200) {
        printf("%s\n",CkJsonObject_emit(json));
        printf("Failed.\n");
    }

    printf("%s\n",CkJsonObject_emit(json));
    printf("----\n");

    // 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;
    numFolders = CkJsonObject_SizeOfArray(json,"value");
    while (i < numFolders) {
        CkJsonObject_putI(json,i);
        printf("%s\n",CkJsonObject_stringOf(json,"value[i].displayName"));
        i = i + 1;
    }

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


    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponse);
    CkJsonObject_Dispose(json);

    }