Sample code for 30+ languages & platforms
Delphi DLL Requires Chilkat v9.5.0.67+

Outlook -- List Messages in a Specified Folder

See more Outlook Examples

Demonstrates how to list the messages in a particular Outlook mailbox folder.

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

Chilkat Delphi DLL Downloads

Delphi DLL
var
success: Boolean;
http: HCkHttp;
sbResponse: HCkStringBuilder;
htFolderMap: HCkHashtable;
sbMap: HCkStringBuilder;
folderId: PWideChar;
json: HCkJsonObject;
i: Integer;
numMessages: Integer;
messageId: PWideChar;
numRecipients: Integer;
j: Integer;
bodyContent: PWideChar;

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

//  Sends:  GET /users/{user_id | userPrincipalName}/mailFolders/{folder_id}/messages
//  Note: It is also possible to use the literal string "me" for the current logged-on user.
//  For example: GET /me/mailFolders/{folder_id}/messages

CkHttp_ClearUrlVars(http);
CkHttp_SetUrlVar(http,'userPrincipalName','chilkatsoft@outlook.com');

//  In this example, we'd like to get the 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.
//  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/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 to list the messages.
success := CkHttp_QuickGetSb(http,'https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$folder_id}/messages',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;

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

    numRecipients := CkJsonObject_SizeOfArray(json,'value[i].toRecipients');
    j := 0;
    while j < numRecipients do
      begin
        CkJsonObject_putJ(json,j);
        Memo1.Lines.Add('To Name: ' + CkJsonObject__stringOf(json,'value[i].toRecipients[j].emailAddress.name'));
        Memo1.Lines.Add('To Addr: ' + CkJsonObject__stringOf(json,'value[i].toRecipients[j].emailAddress.address'));
        j := j + 1;
      end;

    Memo1.Lines.Add('Subject: ' + CkJsonObject__stringOf(json,'value[i].subject'));
    Memo1.Lines.Add('Has Attachments:' + IntToStr(Ord(CkJsonObject_BoolOf(json,'value[i].hasAttachments'))));

    Memo1.Lines.Add('Body Content-Type:' + CkJsonObject__stringOf(json,'value[i].body.contentType'));
    bodyContent := CkJsonObject__stringOf(json,'value[i].body.content');
    //  ...

    Memo1.Lines.Add('----');

    i := i + 1;
  end;

//  The output of the above loop:

//  id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA==
//  From Name: Chilkat Software
//  From Addr: support@chilkatsoft.com
//  To Name: Chilkat Software
//  To Addr: chilkatsoft@outlook.com
//  Subject: email with attachments
//  Has Attachments:True
//  Body Content-Type:html
//  ----
//  id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2gAAAA==
//  From Name: Chilkat Software
//  From Addr: support@chilkatsoft.com
//  To Name: Chilkat Software
//  To Addr: chilkatsoft@outlook.com
//  To Name: admin@chilkat.io
//  To Addr: admin@chilkat.io
//  Subject: Re: Test HTML email with embedded images.
//  Has Attachments:False
//  Body Content-Type:html
//  ----
//  id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA==
//  From Name: Chilkat Software
//  From Addr: support@chilkatsoft.com
//  To Name: chilkatsoft@outlook.com
//  To Addr: chilkatsoft@outlook.com
//  To Name: admin@chilkat.io
//  To Addr: admin@chilkat.io
//  Subject: Test HTML email with embedded images.
//  Has Attachments:False
//  Body Content-Type:html
//  ----

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

//  {
//    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('chilkatsoft%40outlook.com')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA%3D')/messages",
//    "value": [
//      {
//        "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bb\"",
//        "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA==",
//        "createdDateTime": "2017-05-10T00:27:40Z",
//        "lastModifiedDateTime": "2017-05-10T00:30:51Z",
//        "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bb",
//        "categories": [
//        ],
//        "receivedDateTime": "2017-05-10T00:27:41Z",
//        "sentDateTime": "2017-05-10T00:27:12Z",
//        "hasAttachments": true,
//        "internetMessageId": "<9a65d233-0882-d346-f405-202a8b1a3acd@chilkatsoft.com>",
//        "subject": "email with attachments",
//        "bodyPreview": "This email has attachments...",
//        "importance": "normal",
//        "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
//        "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQABQcNI8CG1xKpGjzxJTpoOE=",
//        "isDeliveryReceiptRequested": null,
//        "isReadReceiptRequested": false,
//        "isRead": true,
//        "isDraft": false,
//        "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA%3D%3D&exvsurl=1&viewmodel=ReadMessageItem",
//        "inferenceClassification": "focused",
//        "body": {
//          "contentType": "html",
//          "content": "<html>...</html>\r\n"
//        },
//        "sender": {
//          "emailAddress": {
//            "name": "Chilkat Software",
//            "address": "support@chilkatsoft.com"
//          }
//        },
//        "from": {
//          "emailAddress": {
//            "name": "Chilkat Software",
//            "address": "support@chilkatsoft.com"
//          }
//        },
//        "toRecipients": [
//          {
//            "emailAddress": {
//              "name": "Chilkat Software",
//              "address": "chilkatsoft@outlook.com"
//            }
//          }
//        ],
//        "ccRecipients": [
//        ],
//        "bccRecipients": [
//        ],
//        "replyTo": [
//        ]
//      },
//      {
//        "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bZ\"",
//        "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2gAAAA==",
//        "createdDateTime": "2017-05-10T00:25:28Z",
//        "lastModifiedDateTime": "2017-05-10T00:25:44Z",
//        "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bZ",
//        "categories": [
//        ],
//        "receivedDateTime": "2017-05-10T00:25:28Z",
//        "sentDateTime": "2017-05-10T00:25:10Z",
//        "hasAttachments": false,
//        "internetMessageId": "<707ff357-28ea-7ebd-9409-f46d752e871f@chilkatsoft.com>",
//        "subject": "Re: Test HTML email with embedded images.",
//        "bodyPreview": "My reply...",
//        "importance": "normal",
//        "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
//        "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQACYVrc_6yptKn9tuOqBiUMQ=",
//        "isDeliveryReceiptRequested": null,
//        "isReadReceiptRequested": false,
//        "isRead": true,
//        "isDraft": false,
//        "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2gAAAA%3D%3D&exvsurl=1&viewmodel=ReadMessageItem",
//        "inferenceClassification": "focused",
//        "body": {
//          "contentType": "html",
//          "content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body bgcolor=\"#FFFFFF\">...</body>\r\n</html>\r\n"
//        },
//        "sender": {
//          "emailAddress": {
//            "name": "Chilkat Software",
//  
//            "address": "support@chilkatsoft.com"
//          }
//        },
//        "from": {
//          "emailAddress": {
//            "name": "Chilkat Software",
//            "address": "support@chilkatsoft.com"
//          }
//        },
//        "toRecipients": [
//          {
//            "emailAddress": {
//              "name": "Chilkat Software",
//              "address": "chilkatsoft@outlook.com"
//            }
//          },
//          {
//            "emailAddress": {
//              "name": "admin@chilkat.io",
//              "address": "admin@chilkat.io"
//            }
//          }
//        ],
//        "ccRecipients": [
//          {
//            "emailAddress": {
//              "name": "Matt Smith",
//              "address": "chilkat.support@gmail.com"
//            }
//          }
//        ],
//        "bccRecipients": [
//        ],
//        "replyTo": [
//        ]
//      },
//      {
//        "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bY\"",
//        "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA==",
//        "createdDateTime": "2017-05-10T00:22:23Z",
//        "lastModifiedDateTime": "2017-05-10T00:22:45Z",
//        "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bY",
//        "categories": [
//        ],
//        "receivedDateTime": "2017-05-10T00:22:23Z",
//        "sentDateTime": "2017-05-10T00:22:03Z",
//        "hasAttachments": false,
//        "internetMessageId": "<4da724c6-fa94-5516-81d5-9cdf152eddc5@chilkatsoft.com>",
//        "subject": "Test HTML email with embedded images.",
//        "bodyPreview": "This is a test email with images...",
//        "importance": "normal",
//        "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
//        "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQACYVrc_6yptKn9tuOqBiUMQ=",
//        "isDeliveryReceiptRequested": null,
//        "isReadReceiptRequested": false,
//        "isRead": true,
//        "isDraft": false,
//        "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA%3D%3D&exvsurl=1&viewmodel=ReadMessageItem",
//        "inferenceClassification": "focused",
//        "body": {
//          "contentType": "html",
//          "content": "<html>...</html>\r\n"
//        },
//        "sender": {
//          "emailAddress": {
//            "name": "Chilkat Software",
//            "address": "support@chilkatsoft.com"
//          }
//        },
//        "from": {
//          "emailAddress": {
//            "name": "Chilkat Software",
//            "address": "support@chilkatsoft.com"
//          }
//        },
//        "toRecipients": [
//          {
//            "emailAddress": {
//              "name": "chilkatsoft@outlook.com",
//              "address": "chilkatsoft@outlook.com"
//            }
//          },
//          {
//            "emailAddress": {
//              "name": "admin@chilkat.io",
//              "address": "admin@chilkat.io"
//            }
//          }
//        ],
//        "ccRecipients": [
//          {
//            "emailAddress": {
//              "name": "Matt Smith",
//              "address": "chilkat.support@gmail.com"
//            }
//          }
//        ],
//        "bccRecipients": [
//        ],
//        "replyTo": [
//        ]
//      }
//    ]
//  
//  }

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