(Delphi DLL) IMAP Search with THREAD Semantics

Demonstrates how to search an IMAP mailbox and return message numbers grouped together in parent/child relationships based on which messages are replies to others.

Note: This example requires Chilkat v9.5.0.77 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, JsonArray, Imap, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
imap: HCkImap;
success: Boolean;
json: HCkJsonObject;
numThreads: Integer;
arr: HCkJsonArray;
threadSize: Integer;
i: Integer;
subArr: HCkJsonArray;

begin
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

imap := CkImap_Create();

// Connect to your IMAP server and authenticate..
CkImap_putSsl(imap,True);
CkImap_putPort(imap,993);
success := CkImap_Connect(imap,'imap.mail.us-west-2.awsapps.com');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

success := CkImap_Login(imap,'myLogin','myPassword');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

// Select a mailbox
success := CkImap_SelectMailbox(imap,'Inbox');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

// Search for all message having the letter 'a' somewhere in the Subject,
// and return the messages as JSON.
json := CkImap_ThreadCmd(imap,'REFERENCES','UTF-8','SUBJECT a',True);
if (CkImap_getLastMethodSuccess(imap) = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

// The IMAP server will return a raw response with a format such as this:  (2)(3 6 (4 23)(44 7 96))

// In tree form, it's like this:
// 
//             -- 2
//             -- 3
//                 \-- 6
//                    |-- 4
//                    |      \-- 23
//                    |
//                    |-- 44
//                               \-- 7
//                                       \-- 96
// 

// It means there are 2 main threads returned, but the 2nd thread splits into two sub-threads.
// In total, we can think of it as 3 threads -- 2 main threads (with no parents) and one sub-thread w/ a parent.
// 
// - The 1st thread contains the message 2, and has no parent thread.
// - The 2nd thread contains the messages 3, 6, 4, 23, and has no parent thread.
// - The 3rd thread contains the messages 44, 7, 96 and the parent thread is message 6.
// 

// (Yes, this is all highly confusing...)

// Chilkat will return the above sample response as JSON that looks like this:

// {
//   "threads": [
//     [2],
//     [3, 6, [4, 23], [44, 7, 96]]
//   ]
// }
// 

// Use this online tool to generate parsing code from sample JSON: 
// Generate Parsing Code from JSON
// In this case, the online tool can help you get a feel for how to write the JSON parsing code..

numThreads := CkJsonObject_SizeOfArray(json,'threads');
Memo1.Lines.Add('The total number of top-level threads is ' + IntToStr(numThreads));

// Let's say we wanted to get the messages in the thread 3, 6, 4, 23.
// We always follow the 1st branch to the bottom, ignoring the other branches.
// For example, if we had  [3, 5, [4, 23, [55, 56, 57], [68, 69]], [44, 7, 96]]
// then the thread would be 3, 5, 4, 43, 55, 56, 57

// For testing, let's substitute the response from the IMAP server with this sample:
CkJsonObject_Load(json,'{"threads": [[2], [3, 5, [4, 23, [55, 56, 57], [68, 69]], [44, 7, 96]]]}');

// Begin with the 2nd top-level thread, which is at index 1.
Memo1.Lines.Add('Following the 2nd top level thread...');
arr := CkJsonObject_ArrayOf(json,'threads[1]');
threadSize := CkJsonArray_getSize(arr);
i := 0;
while i < threadSize do
  begin
    // Do we have an array or integer at this position?
    if (CkJsonArray_TypeAt(arr,i) = 4) then
      begin
        // This is a sub-array.
        subArr := CkJsonArray_ArrayAt(arr,i);
        CkJsonArray_Dispose(arr);
        // Follow the sub-array starting at the 1st position..
        arr := subArr;
        i := 0;
        threadSize := CkJsonArray_getSize(arr);
      end
    else
      begin
        // Must be a single integer.
        Memo1.Lines.Add(IntToStr(CkJsonArray_IntAt(arr,i)));
        i := i + 1;
      end;
  end;

CkJsonObject_Dispose(json);

// The output is:
// 
// Following the 2nd top level thread...
// 3
// 5
// 4
// 23
// 55
// 56
// 57

CkImap_Dispose(imap);

end;