Objective-C

Outlook -- Create Map of Folder Paths to IDs

See more Outlook Examples

Recursively descends folders and creates a hashtable of folder paths to IDs. This can be done once at the start of your program (or even less if the map is persisted to a file or database).

The reason this is necessary is because folder ID's need to be passed to the Outlook API, and an application will typically be working with folder paths.

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

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

Objective-C

#import <CkoHttp.h>
#import <CkoHashtable.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <CkoStringArray.h>
#import <NSString.h>

BOOL success = NO;

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

CkoHttp *http = [[CkoHttp alloc] init];

// Our folder path --> ID map will be stored in this hash table.
CkoHashtable *folderMap = [[CkoHashtable alloc] init];

// 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";

CkoStringBuilder *sbResponse = [[CkoStringBuilder alloc] init];

// Begin by getting the top-level folders.
[http ClearUrlVars];
[http SetUrlVar: @"userPrincipalName" value: @"chilkatsoft@outlook.com"];
success = [http QuickGetSb: @"https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders" sbContent: sbResponse];
if ((success != YES) && ([http.LastStatus intValue] == 0)) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json LoadSb: sbResponse];
json.EmitCompact = NO;

NSLog(@"%@%d",@"Status code = ",[http.LastStatus intValue]);
if ([http.LastStatus intValue] != 200) {
    NSLog(@"%@",[json Emit]);
    NSLog(@"%@",@"Failed.");
}

// This is our queue/stack of unprocessed folder ID's
// The recursive nature of this example is that we get the 
// child folders for each folder ID in the idQueue, which may
// cause additional ID's to be added.  We continue  until the idQueue
// is empty.
CkoStringArray *idQueue = [[CkoStringArray alloc] init];

CkoStringBuilder *sbFolderPath = [[CkoStringBuilder alloc] init];
CkoStringBuilder *sbQueueEntry = [[CkoStringBuilder alloc] init];
NSString *folderName = 0;
NSString *folderPath = 0;
NSString *folderId = 0;

// Prime the map and idQueue with the top-level folders.
int i = 0;
int numFolders = [[json SizeOfArray: @"value"] intValue];
while (i < numFolders) {
    json.I = [NSNumber numberWithInt: i];
    folderName = [json StringOf: @"value[i].displayName"];
    folderId = [json StringOf: @"value[i].id"];
    [sbFolderPath SetString: @"/"];
    [sbFolderPath Append: folderName];
    folderPath = [sbFolderPath GetAsString];
    [folderMap AddStr: folderPath value: folderId];
    NSLog(@"%@%@%@",folderPath,@" --> ",folderId);

    // Push the folder path + id onto the idQueue.
    [sbQueueEntry Clear];
    [sbQueueEntry SetNth: [NSNumber numberWithInt: 0] value: folderPath delimiterChar: @"|" exceptDoubleQuoted: NO exceptEscaped: NO];
    [sbQueueEntry SetNth: [NSNumber numberWithInt: 1] value: folderId delimiterChar: @"|" exceptDoubleQuoted: NO exceptEscaped: NO];
    [idQueue Append: [sbQueueEntry GetAsString]];
    i = i + 1;
}

// Initial output:
// /Archive --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=
// /Deleted Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA
// /Drafts --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA
// /Inbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA
// /Junk Email --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA
// /Outbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA
// /Sent Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA
// 

// Process the idQueue until it becomes empty.  This is the recursive loop.
NSString *parentFolderPath = 0;
NSString *parentFolderId = 0;
while ([idQueue.Length intValue] > 0) {
    [sbQueueEntry SetString: [idQueue GetString: [NSNumber numberWithInt: 0]]];
    [idQueue RemoveAt: [NSNumber numberWithInt: 0]];

    parentFolderPath = [sbQueueEntry GetNth: [NSNumber numberWithInt: 0] delimiterChar: @"|" exceptDoubleQuoted: NO exceptEscaped: NO];
    parentFolderId = [sbQueueEntry GetNth: [NSNumber numberWithInt: 1] delimiterChar: @"|" exceptDoubleQuoted: NO exceptEscaped: NO];

    [http SetUrlVar: @"id" value: parentFolderId];
    success = [http QuickGetSb: @"https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$id}/childFolders" sbContent: sbResponse];
    if ((success != YES) && ([http.LastStatus intValue] == 0)) {
        NSLog(@"%@",http.LastErrorText);
        return;
    }

    [json LoadSb: sbResponse];
    if ([http.LastStatus intValue] != 200) {
        NSLog(@"%@%d",@"Status code = ",[http.LastStatus intValue]);
        NSLog(@"%@",[json Emit]);
        NSLog(@"%@",@"Failed.");
    }

    i = 0;
    numFolders = [[json SizeOfArray: @"value"] intValue];
    while (i < numFolders) {
        json.I = [NSNumber numberWithInt: i];
        folderName = [json StringOf: @"value[i].displayName"];
        folderId = [json StringOf: @"value[i].id"];
        [sbFolderPath SetString: parentFolderPath];
        [sbFolderPath Append: @"/"];
        [sbFolderPath Append: folderName];
        folderPath = [sbFolderPath GetAsString];
        [folderMap AddStr: folderPath value: folderId];
        NSLog(@"%@%@%@",folderPath,@" --> ",folderId);

        // Push the folder path + id onto the idQueue.
        [sbQueueEntry Clear];
        [sbQueueEntry SetNth: [NSNumber numberWithInt: 0] value: folderPath delimiterChar: @"|" exceptDoubleQuoted: NO exceptEscaped: NO];
        [sbQueueEntry SetNth: [NSNumber numberWithInt: 1] value: folderId delimiterChar: @"|" exceptDoubleQuoted: NO exceptEscaped: NO];
        [idQueue Append: [sbQueueEntry GetAsString]];
        i = i + 1;
    }

}

// The hash table of mail folder paths --> ID's can be persisted to XML and saved to a file or database (or anywhere..)
CkoStringBuilder *sbFolderMapXml = [[CkoStringBuilder alloc] init];
[folderMap ToXmlSb: sbFolderMapXml];
[sbFolderMapXml WriteFile: @"qa_data/outlook/folderMap.xml" charset: @"utf-8" emitBom: NO];

// The hash table can be restored from the serialized XML like this:
CkoHashtable *ht2 = [[CkoHashtable alloc] init];
CkoStringBuilder *sb2 = [[CkoStringBuilder alloc] init];
[sb2 LoadFile: @"qa_data/outlook/folderMap.xml" charset: @"utf-8"];
[ht2 AddFromXmlSb: sb2];

// What's the ID for the folder "/Inbox/abc/subFolderA" ?
NSLog(@"%@%@",@"id for /Inbox/abc/subFolderA = ",[ht2 LookupStr: @"/Inbox/abc/subFolderA"]);

// Final output:

// /Archive --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=
// /Deleted Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA
// /Drafts --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA
// /Inbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA
// /Junk Email --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA
// /Outbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA
// /Sent Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA
// /Inbox/abc --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=
// /Inbox/xyz --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwEAAAA=
// /Inbox/abc/subFolderA --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwAAAQ==
// /Inbox/abc/subFolderB --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwMAAAA=
// /Inbox/abc/subFolderA/a --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwIAAAA=
// 

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