Delphi DLL

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 DLL Downloads

Download Chilkat for Delphi DLL

Delphi DLL

var
success: Boolean;
imap: HCkImap;
msgSet: HCkMessageSet;
uid: Cardinal;

begin
success := False;

//  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 := CkImap_Create();

CkImap_putSsl(imap,True);
CkImap_putPort(imap,993);

success := CkImap_Connect(imap,'imap.example.com');
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;
success := CkImap_Login(imap,'user@example.com','myPassword');
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

success := CkImap_SelectMailbox(imap,'Inbox');
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

//  Get the UIDs of all messages.
msgSet := CkMessageSet_Create();
success := CkImap_QueryMbx(imap,'ALL',True,msgSet);
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

if (CkMessageSet_getCount(msgSet) > 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 := CkMessageSet_GetId(msgSet,0);
    success := CkImap_StoreFlags(imap,uid,True,'Seen Flagged',1);
    if (success = False) then
      begin
        Memo1.Lines.Add(CkImap__lastErrorText(imap));
        Exit;
      end;
    Memo1.Lines.Add('Updated flags on UID ' + IntToStr(uid));
  end;

success := CkImap_Disconnect(imap);
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

CkImap_Dispose(imap);
CkMessageSet_Dispose(msgSet);