Delphi DLL

Outlook -- Get Number of Emails

See more Outlook Examples

Gets the number of emails in an Outlook folder. This uses the OData $count system query option. See OData System Query Option $count for general information.

This example first gets the combined total number of messages across all folders.

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

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

Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, StringBuilder, Hashtable, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
sbResponse: HCkStringBuilder;
json: HCkJsonObject;
htFolderMap: HCkHashtable;
sbMap: HCkStringBuilder;
folderId: PWideChar;
totalItemCount: Integer;
childFolderCount: Integer;

begin
success := False;

// 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();

// This gets the combined total number of emails in all folders.
success := CkHttp_QuickGetSb(http,'https://graph.microsoft.com/v1.0/me/messages/$count',sbResponse);
if ((success <> True) and (CkHttp_getLastStatus(http) = 0)) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

json := CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,False);

// If the status code was not 200, then it failed and the response is likely JSON:
if (CkHttp_getLastStatus(http) <> 200) then
  begin
    Memo1.Lines.Add('Status code = ' + IntToStr(CkHttp_getLastStatus(http)));
    CkJsonObject_LoadSb(json,sbResponse);
    Memo1.Lines.Add(CkJsonObject__emit(json));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// A success response payload contains just the integer value (it is not JSON)
Memo1.Lines.Add('Combined Total Number of Emails = ' + CkStringBuilder__getAsString(sbResponse));
Memo1.Lines.Add('--');

// ---------------------------------------------------------------------------
// To get the number of emails in a particular folder, we need to use the folder id.
// 

// In this example, we'd like to get number of messages in the folder "/Inbox/abc",
// but we must specify the corresponding folder_id.  The best way to do this is to create
// a local map of folderPaths-to-folderIds.
// We'll use the map created by this example:  Create Outlook Folder Map)
htFolderMap := CkHashtable_Create();
sbMap := CkStringBuilder_Create();
CkStringBuilder_LoadFile(sbMap,'qa_data/outlook/folderMap.xml','utf-8');
CkHashtable_AddFromXmlSb(htFolderMap,sbMap);

// Get the ID for the "/Inbox/abc" folder:
folderId := CkHashtable__lookupStr(htFolderMap,'/Inbox/abc');
if (CkHashtable_getLastMethodSuccess(htFolderMap) <> True) then
  begin
    Memo1.Lines.Add('Folder ID not found');
    Exit;
  end;
CkHttp_SetUrlVar(http,'folder_id',folderId);

// Send the request get the folder information.
// In this case we are NOT using the $count system query option.
success := CkHttp_QuickGetSb(http,'https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}',sbResponse);
if ((success <> True) and (CkHttp_getLastStatus(http) = 0)) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

CkJsonObject_LoadSb(json,sbResponse);
Memo1.Lines.Add(CkJsonObject__emit(json));
Memo1.Lines.Add('--');

if (CkHttp_getLastStatus(http) <> 200) then
  begin
    Memo1.Lines.Add('Status code = ' + IntToStr(CkHttp_getLastStatus(http)));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// The successful JSON response looks like this;

// 	{
// 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders/$entity",
// 	  "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
// 	  "displayName": "abc",
// 	  "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA",
// 	  "childFolderCount": 2,
// 	  "unreadItemCount": 0,
// 	  "totalItemCount": 3
// 	}
// 

// Get the integer value from the JSON like this:
totalItemCount := CkJsonObject_IntOf(json,'totalItemCount');
Memo1.Lines.Add('totalItemCount = ' + IntToStr(totalItemCount));

childFolderCount := CkJsonObject_IntOf(json,'childFolderCount');
Memo1.Lines.Add('childFolderCount = ' + IntToStr(childFolderCount));

// etc..

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkJsonObject_Dispose(json);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);

end;