Pascal (Lazarus/Delphi)

IMAP Get List of Flags

See more IMAP Examples

When a mailbox is selected, the server response includes a list of flags:

The FLAGS response occurs as a result of a SELECT or EXAMINE command. The flag parenthesized list identifies the flags (at a minimum, the system-defined flags) that are applicable for this mailbox. Flags other than the system flags can also exist, depending on server implementation.

This example demonstrates how to capture the SELECT (or EXAMINE) response, and parse the list of flags. 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.StringTable,
  Chilkat.StringBuilder,
  Chilkat.Imap;

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

procedure RunDemo;
var
  success: Boolean;
  imap: TImap;
  selectResponse: string;
  sbResponse: TStringBuilder;
  sbFlagList: TStringBuilder;
  numReplaced: Integer;
  flagsTable: TStringTable;
  i: Integer;

begin
  success := False;

  imap := TImap.Create;

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

  //  Connect to an IMAP server.
  //  Use TLS
  imap.Ssl := True;
  imap.Port := 993;
  success := imap.Connect('MY-IMAP-DOMAIN');
  if (success <> True) then
    begin
      WriteLn(imap.LastErrorText);
      Exit;
    end;

  //  Login
  success := imap.Login('MY-IMAP-LOGIN','MY-IMAP-PASSWORD');
  if (success <> True) then
    begin
      WriteLn(imap.LastErrorText);
      Exit;
    end;

  //  Select an IMAP mailbox
  success := imap.SelectMailbox('INBOX');
  if (success <> True) then
    begin
      WriteLn(imap.LastErrorText);
      Exit;
    end;

  //  The LastResponse property contains the full response of the last command.
  selectResponse := imap.LastResponse;
  WriteLn(selectResponse);

  //  For example, on GMail, the SELECT response looks like this:

  //  	* FLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk)
  //  	* OK [PERMANENTFLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk \*)] Flags permitted.
  //  	* OK [UIDVALIDITY 3] UIDs valid.
  //  	* 46 EXISTS
  //  	* 0 RECENT
  //  	* OK [UIDNEXT 4147] Predicted next UID.
  //  	* OK [HIGHESTMODSEQ 402971]
  //  	aaac OK [READ-WRITE] INBOX selected. (Success)

  //  The goal of this example is to capture the list of FLAGS.
  //  All IMAP servers will respond with the list of flags in a SPACE separated list enclosed in parentheses.

  sbResponse := TStringBuilder.Create;
  sbResponse.Append(selectResponse);

  //  Get just the list of flags:
  sbFlagList := TStringBuilder.Create;
  sbFlagList.Append(sbResponse.GetAfterBetween('* FLAGS','(',')'));
  WriteLn(sbFlagList.GetAsString());

  //  sbFlagList contains this:  
  //  
  //      \Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk
  //  

  //  Make sure no more than one SPACE char in a row exists.
  sbFlagList.TrimInsideSpaces();
  //  Modify sbFlagList to one flag per line
  numReplaced := sbFlagList.Replace(' ',#13#10);

  //  Load a StringTable with the flag names.
  flagsTable := TStringTable.Create;
  flagsTable.AppendFromSb(sbFlagList);

  //  Iterate over the individual flag names:
  i := 0;
  while i < flagsTable.Count do
    begin
      WriteLn(i + ': ' + flagsTable.StringAt(i));
      i := i + 1;
    end;

  //  The output is:
  //  
  //  	0: \Answered
  //  	1: \Flagged
  //  	2: \Draft
  //  	3: \Deleted
  //  	4: \Seen
  //  	5: $Forwarded
  //  	6: $NotPhishing
  //  	7: $Phishing
  //  	8: $label1
  //  	9: $label2
  //  	10: $label3
  //  	11: $label4
  //  	12: $label5
  //  	13: Junk
  //  	14: NonJunk
  //  


  imap.Free;
  sbResponse.Free;
  sbFlagList.Free;
  flagsTable.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.