Delphi ActiveX

Store One or More Flags on a Single Message

Demonstrates the Chilkat Imap.StoreFlags method, which sets or clears one or more flags on a single message identified by ID. The first argument is the message ID, the second (bUid) selects UID vs sequence number, the third is a space-separated list of flag names, and the fourth is the value (1 to set, 0 to clear). This example applies the Seen and Flagged flags to one message by UID.

Background: StoreFlags is the single-message counterpart to SetFlags and lets you change several flags at once by listing them space-separated (without leading backslashes). Because the ID can be either a UID or a sequence number, the bUid argument must match how you obtained it — a UID from a UID search, or a sequence number from a sequence-based operation. UIDs are the safer choice since they remain valid as the mailbox changes.

Chilkat Delphi ActiveX Downloads

Download Chilkat for Delphi ActiveX

Delphi ActiveX

var
success: Integer;
imap: TChilkatImap;
msgSet: TMessageSet;
uid: Cardinal;

begin
success := 0;

//  Demonstrates the Imap.StoreFlags method, which sets or clears one or more flags on a single
//  message identified by ID.  The 1st argument is the message ID, the 2nd (bUid) selects UID
//  vs sequence number, the 3rd is a space-separated list of flag names, and the 4th is the
//  value (1 to set, 0 to clear).

imap := TChilkatImap.Create(Self);

imap.Ssl := 1;
imap.Port := 993;

success := imap.Connect('imap.example.com');
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;
success := imap.Login('user@example.com','myPassword');
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

success := imap.SelectMailbox('Inbox');
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

//  Get the UIDs of all messages.
msgSet := TMessageSet.Create(Self);
success := imap.QueryMbx('ALL',1,msgSet.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

if (msgSet.Count > 0) then
  begin
    //  Apply the Seen and Flagged flags to the first message.  bUid is 1 because the ID
    //  came from a UID search.
    uid := msgSet.GetId(0);
    success := imap.StoreFlags(uid,1,'Seen Flagged',1);
    if (success = 0) then
      begin
        Memo1.Lines.Add(imap.LastErrorText);
        Exit;
      end;
    Memo1.Lines.Add('Updated flags on UID ' + IntToStr(uid));
  end;

success := imap.Disconnect();
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;