TElIMAPClient.Store method

TElIMAPClient.Store

Updates message statuses on the server.

Declaration

[C#]
void Store(int First, int Last, bool UID, TSBIMAPStoreFlagsOperation Operation, TSBIMAPMessageFlags Flags, bool Silent, TElIMAPFetchResponse Response);
void Store(TElIMAPFetchResponse Sequence, TSBIMAPStoreFlagsOperation Operation, TSBIMAPMessageFlags Flags, bool Silent, TElIMAPFetchResponse Response);

[VB.NET]
Sub Store(ByVal First As Integer, ByVal Last As Integer, ByVal UID As Boolean, ByVal Operation As TSBIMAPStoreFlagsOperation, ByVal Flags As TSBIMAPMessageFlags, ByVal Silent As Boolean, ByVal Response As TElIMAPFetchResponse)
Sub Store(ByVal Sequence As TElIMAPFetchResponse, ByVal Operation As TSBIMAPStoreFlagsOperation, ByVal Flags As TSBIMAPMessageFlags, ByVal Silent As Boolean, ByVal Response As TElIMAPFetchResponse)

[Pascal]
procedure Store(First : Integer; Last : Integer; UID : Boolean; Operation : TSBIMAPStoreFlagsOperation; Flags : TSBIMAPMessageFlags; Silent : Boolean; Response : TElIMAPFetchResponse);
procedure Store(Sequence : TElIMAPFetchResponse; Operation : TSBIMAPStoreFlagsOperation; Flags : TSBIMAPMessageFlags; Silent : Boolean; Response : TElIMAPFetchResponse);

[C++]
    void Store(int32_t First, int32_t Last, bool UID, TSBIMAPStoreFlagsOperation Operation, TSBIMAPMessageFlags Flags, bool Silent, TElIMAPFetchResponse &Response);
    void Store(int32_t First, int32_t Last, bool UID, TSBIMAPStoreFlagsOperation Operation, TSBIMAPMessageFlags Flags, bool Silent, TElIMAPFetchResponse *Response);
    void Store(TElIMAPFetchResponse &Sequence, TSBIMAPStoreFlagsOperation Operation, TSBIMAPMessageFlags Flags, bool Silent, TElIMAPFetchResponse &Response);
    void Store(TElIMAPFetchResponse *Sequence, TSBIMAPStoreFlagsOperation Operation, TSBIMAPMessageFlags Flags, bool Silent, TElIMAPFetchResponse *Response);

[PHP]
void Store(integer $First, integer $Last, bool $UID, integer $Operation, integer $Flags, bool $Silent, TElIMAPFetchResponse $Response)
void Store(TElIMAPFetchResponse $Sequence, integer $Operation, integer $Flags, bool $Silent, TElIMAPFetchResponse $Response)

[Java]
void store(int First, int Last, boolean UID, TSBIMAPStoreFlagsOperation Operation, TSBIMAPMessageFlags Flags, boolean Silent, TElIMAPFetchResponse Response);
void store(TElIMAPFetchResponse Sequence, TSBIMAPStoreFlagsOperation Operation, TSBIMAPMessageFlags Flags, boolean Silent, TElIMAPFetchResponse Response);

Parameters

First - specifies the first message to be retrieved.
Last - specifies the last message to be retrieved.
UID - defines whether parameters First and Last specify message sequence numbers (UID is false) or message UIDs (UID is true).
Operation - the operation to be applied to message flags.
Flags - defines which flags should be updated.
Silent - set this parameter to true if the server should omit any response (sends a ".SILENT" STORE command and do not fetch the updated message list).
Response - server's response (if any) will be saved into this parameter.
Sequence - defines the sequence of messages to be updated.

TSBIMAPStoreFlagsOperation values

[.NET][C++]	[Pascal]	[PHP]	Description
imapReplaceFlags = 0	imapReplaceFlags	imapReplaceFlags = 0	Replace flags with the new values.
imapAddFlags = 1	imapAddFlags	imapAddFlags = 1	Add new flags to the existing ones.
imapRemoveFlags = 2	imapRemoveFlags	imapRemoveFlags = 2	Remove all flags.

TSBIMAPMessageFlags values

[.NET][C++]	[Pascal]	[PHP]	Description
f_imapUnknownFlag = 1	imapUnknownFlag	imapUnknownFlag = 1	unknown status.
f_imapAnsweredFlag = 2	imapAnsweredFlag	imapAnsweredFlag = 2	message has been answered.
f_imapFlaggedFlag = 4	imapFlaggedFlag	imapFlaggedFlag = 4	message is flagged (marked as important or with an asterisk) on the server.
f_imapDeletedFlag = 8	imapDeletedFlag	imapDeletedFlag = 8	message is marked for deletion on the server.
f_imapSeenFlag = 16	imapSeenFlag	imapSeenFlag = 16	the message has been read.
f_imapDraftFlag = 32	imapDraftFlag	imapDraftFlag = 32	the message is a draft.
f_imapSpecialFlag = 64	imapSpecialFlag	imapSpecialFlag = 64	a reserved special flag.

Description

Use this method to update message statuses on the server. In particular, you can use this method to mark messages as "deleted". After this call Expunge() to remove the message on the server side.