Java
Chilkat2 Java
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
Chilkat Java Downloads
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Hashtable;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.StringArray;
import com.chilkatsoft.chilkat2.StringBuilder;
public class ChilkatExample {
public static void main(String[] args) {
boolean success = false;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Http http = new Http();
// Our folder path --> ID map will be stored in this hash table.
Hashtable folderMap = new Hashtable();
// 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.setAuthToken("MICROSOFT_GRAPH_ACCESS_TOKEN");
StringBuilder sbResponse = new StringBuilder();
// Begin by getting the top-level folders.
http.clearUrlVars();
http.setUrlVar("userPrincipalName", "chilkatsoft@outlook.com");
try {
http.quickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders", sbResponse);
success = true;
} catch (ChilkatException e) {
success = false;
}
if ((!success) && (http.getLastStatus() == 0)) {
System.out.println(http.getLastErrorText());
return;
}
JsonObject json = new JsonObject();
json.loadSb(sbResponse);
json.setEmitCompact(false);
System.out.println("Status code = " + http.getLastStatus());
if (http.getLastStatus() != 200) {
System.out.println(json.emit());
System.out.println("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.
StringArray idQueue = new StringArray();
StringBuilder sbFolderPath = new StringBuilder();
StringBuilder sbQueueEntry = new StringBuilder();
String folderName = "";
String folderPath = "";
String folderId = "";
// Prime the map and idQueue with the top-level folders.
int i = 0;
int numFolders = json.sizeOfArray("value");
while (i < numFolders) {
json.setI(i);
folderName = json.stringOf("value[i].displayName");
folderId = json.stringOf("value[i].id");
sbFolderPath.setString("/");
sbFolderPath.append(folderName);
folderPath = sbFolderPath.getAsString();
folderMap.addStr(folderPath, folderId);
System.out.println(folderPath + " --> " + folderId);
// Push the folder path + id onto the idQueue.
sbQueueEntry.clear();
sbQueueEntry.setNth(0, folderPath, "|", false, false);
sbQueueEntry.setNth(1, folderId, "|", false, false);
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.
String parentFolderPath = "";
String parentFolderId = "";
while (idQueue.getLength() > 0) {
sbQueueEntry.setString(idQueue.getString(0));
idQueue.removeAt(0);
parentFolderPath = sbQueueEntry.getNth(0, "|", false, false);
parentFolderId = sbQueueEntry.getNth(1, "|", false, false);
http.setUrlVar("id", parentFolderId);
try {
http.quickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$id}/childFolders", sbResponse);
success = true;
} catch (ChilkatException e) {
success = false;
}
if ((!success) && (http.getLastStatus() == 0)) {
System.out.println(http.getLastErrorText());
return;
}
json.loadSb(sbResponse);
if (http.getLastStatus() != 200) {
System.out.println("Status code = " + http.getLastStatus());
System.out.println(json.emit());
System.out.println("Failed.");
}
i = 0;
numFolders = json.sizeOfArray("value");
while (i < numFolders) {
json.setI(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, folderId);
System.out.println(folderPath + " --> " + folderId);
// Push the folder path + id onto the idQueue.
sbQueueEntry.clear();
sbQueueEntry.setNth(0, folderPath, "|", false, false);
sbQueueEntry.setNth(1, folderId, "|", false, false);
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..)
StringBuilder sbFolderMapXml = new StringBuilder();
folderMap.toXmlSb(sbFolderMapXml);
sbFolderMapXml.writeFile("qa_data/outlook/folderMap.xml", "utf-8", false);
// The hash table can be restored from the serialized XML like this:
Hashtable ht2 = new Hashtable();
StringBuilder sb2 = new StringBuilder();
sb2.loadFile("qa_data/outlook/folderMap.xml", "utf-8");
ht2.addFromXmlSb(sb2);
// What's the ID for the folder "/Inbox/abc/subFolderA" ?
System.out.println("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.
}
}