Pascal (Lazarus/Delphi)

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

Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.Http,
  Chilkat.StringBuilder,
  Chilkat.Hashtable,
  Chilkat.JsonObject;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  http: THttp;
  sbResponse: TStringBuilder;
  json: TJsonObject;
  htFolderMap: THashtable;
  sbMap: TStringBuilder;
  folderId: string;
  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 := THttp.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).

  http.AuthToken := 'MICROSOFT_GRAPH_ACCESS_TOKEN';

  sbResponse := TStringBuilder.Create;

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

  json := TJsonObject.Create;
  json.EmitCompact := False;

  //  If the status code was not 200, then it failed and the response is likely JSON:
  if (http.LastStatus <> 200) then
    begin
      WriteLn('Status code = ' + http.LastStatus);
      json.LoadSb(sbResponse);
      WriteLn(json.Emit());
      WriteLn('Failed.');
      Exit;
    end;

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

  //  ---------------------------------------------------------------------------
  //  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 := THashtable.Create;
  sbMap := TStringBuilder.Create;
  sbMap.LoadFile('qa_data/outlook/folderMap.xml','utf-8');
  htFolderMap.AddFromXmlSb(sbMap);

  //  Get the ID for the "/Inbox/abc" folder:
  folderId := htFolderMap.LookupStr('/Inbox/abc');
  if (htFolderMap.LastMethodSuccess <> True) then
    begin
      WriteLn('Folder ID not found');
      Exit;
    end;
  http.SetUrlVar('folder_id',folderId);

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

  json.LoadSb(sbResponse);
  WriteLn(json.Emit());
  WriteLn('--');

  if (http.LastStatus <> 200) then
    begin
      WriteLn('Status code = ' + http.LastStatus);
      WriteLn('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 := json.IntOf('totalItemCount');
  WriteLn('totalItemCount = ' + totalItemCount);

  childFolderCount := json.IntOf('childFolderCount');
  WriteLn('childFolderCount = ' + childFolderCount);

  //  etc..


  http.Free;
  sbResponse.Free;
  json.Free;
  htFolderMap.Free;
  sbMap.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.