(Delphi DLL) Outlook -- List Selected Fields in Messages

Demonstrates how to list the messages in a particular Outlook mailbox folder, but selects particular fields to be returned.

This uses the OData $select system query option. See OData System Query Option $select for general information.

Also see OData URL Conventions for information about $select and other query options.

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

Chilkat for Delphi Downloads

Chilkat non-ActiveX DLL for Delphi

Chilkat ActiveX DLL for Delphi

* The examples here use the non-ActiveX 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
http: HCkHttp;
sbResponse: HCkStringBuilder;
htFolderMap: HCkHashtable;
sbMap: HCkStringBuilder;
folderId: PWideChar;
success: Boolean;
json: HCkJsonObject;
i: Integer;
numMessages: Integer;
messageId: PWideChar;

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

// In this example, we'd like to get the messages in the folder "/Inbox",
// but we must specify the corresponding folder_id.  The best way to do this is to create
// a local map of folderPaths-to-folderIds.
// This example does it:  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" folder:
folderId := CkHashtable__lookupStr(htFolderMap,'/Inbox');
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 to list the messages, returning only the subject and from address.
success := CkHttp_QuickGetSb(http,'https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$select=subject,from',sbResponse);
if ((success <> True) and (CkHttp_getLastStatus(http) = 0)) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

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

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

Memo1.Lines.Add(CkJsonObject__emit(json));

// In my test case, the raw JSON returned is shown below.
// Iterate over the messages to get information about each..

i := 0;
numMessages := CkJsonObject_SizeOfArray(json,'value');
while i < numMessages do
  begin
    CkJsonObject_putI(json,i);

    // This is the id for the email message.
    // For REST API calls that require particular email message id, this is what should be used..
    messageId := CkJsonObject__stringOf(json,'value[i].id');
    Memo1.Lines.Add('id: ' + messageId);
    Memo1.Lines.Add('From Name: ' + CkJsonObject__stringOf(json,'value[i].from.emailAddress.name'));
    Memo1.Lines.Add('From Addr: ' + CkJsonObject__stringOf(json,'value[i].from.emailAddress.address'));
    Memo1.Lines.Add('Subject: ' + CkJsonObject__stringOf(json,'value[i].subject'));
    Memo1.Lines.Add('--');

    i := i + 1;
  end;

// The output of the above loop:
// 
// 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1oAAAA=
// 	From Name: Chilkat Software
// 	From Addr: admin@chilkat.io
// 	Subject: This is an example email from chilkat.io
// 	--
// 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1kAAAA=
// 	From Name: Chilkat Support
// 	From Addr: chilkat.support@gmail.com
// 	Subject: Hello from GMail
// 	--
// 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAHrLra8AAAA=
// 	From Name: Microsoft Office 365
// 	From Addr: MicrosoftOffice365@email.office.com
// 	Subject: The latest for you in Office 365
// 	--
// 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_EAAAA=
// 	From Name: Amazon Web Services
// 	From Addr: no-reply-aws@amazon.com
// 	Subject: Amazon SES Address Verification Request in region US West (Oregon)
// 	--
// 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_AAAAA=
// 	From Name: Amazon Web Services
// 	From Addr: no-reply-aws@amazon.com
// 	Subject: Amazon SES Address Verification Request in region US West (Oregon)
// 	--
// 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAAG6l8UAAAA=
// 	From Name: Microsoft
// 	From Addr: msa@communication.microsoft.com
// 	Subject: Updates to our terms of use and privacy statement
// 	--
// 

// ------------------------------------------------------
// This is the raw JSON response:

// {
//   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA')/messages(subject,from)",
//   "value": [
//     {
//       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfo\"",
//       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1oAAAA=",
//       "subject": "This is an example email from chilkat.io",
//       "from": {
//         "emailAddress": {
//           "name": "Chilkat Software",
//           "address": "admin@chilkat.io"
//         }
//       }
//     },
//     {
//       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfn\"",
//       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1kAAAA=",
//       "subject": "Hello from GMail",
//       "from": {
//         "emailAddress": {
//           "name": "Chilkat Support",
//           "address": "chilkat.support@gmail.com"
//         }
//       }
//     },
//     {
//       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAB63d8O\"",
//       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAHrLra8AAAA=",
//       "subject": "The latest for you in Office 365",
//       "from": {
//         "emailAddress": {
//           "name": "Microsoft Office 365",
//           "address": "MicrosoftOffice365@email.office.com"
//         }
//       }
//     },
//     {
//       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAA1jyl7\"",
//       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_EAAAA=",
//       "subject": "Amazon SES Address Verification Request in region US West (Oregon)",
//       "from": {
//         "emailAddress": {
//           "name": "Amazon Web Services",
//           "address": "no-reply-aws@amazon.com"
//         }
//       }
//     },
//     {
//       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAA1jyl6\"",
//       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_AAAAA=",
//       "subject": "Amazon SES Address Verification Request in region US West (Oregon)",
//       "from": {
//         "emailAddress": {
//           "name": "Amazon Web Services",
//           "address": "no-reply-aws@amazon.com"
//         }
//       }
//     },
//     {
//       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAAGt5YG\"",
//       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAAG6l8UAAAA=",
//       "subject": "Updates to our terms of use and privacy statement",
//       "from": {
//         "emailAddress": {
//           "name": "Microsoft",
//           "address": "msa@communication.microsoft.com"
//         }
//       }
//     }
//   ]
// }

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

end;