Topic Path: Symbol Reference > Classes > TIdIMAP4 Class > TIdIMAP4 Methods > StoreFlags Method
ContentsIndexHome
PreviousUpNext
TIdIMAP4.StoreFlags Method

Updates the specified message flags for a list of message numbers.

function StoreFlags(
    const AMsgNumList: array of Integer; 
    const AStoreMethod: TIdIMAP4StoreDataItem; 
    const AFlags: TIdMessageFlagsSet
): Boolean;
Parameters 
Description 
AMsgNumList 
Message numbers to be updated by the method.
 
AStoreMethod 
Method to use for storing flag values.
 
AFlags 
Message flags to be updated for the specified messages. 

Boolean - True on success.

StoreFlags is a Boolean function that updates the message flags specified in AFlags for the list of message numbers specified in AMsgNumList. AStoreMethod indicates if the message flags are added, replaced or removed. 

When AMsgNumList has a length of zero, the return value for the method is set to False and the method is exited. StoreFlags requires that ConnectionState contain the value csSelected, or an EIdConnectionStateError exception will be raised. 

StoreFlags calls SendCmd using the IMAP4 STORE command for the specified messages and flags. StoreFlags sets the return value for the method to True when the server response contains the value IMAP_OK.

Copyright 1993-2006, Chad Z. Hower (aka Kudzu) and the Indy Pit Crew. All rights reserved.
Post feedback to the Indy Docs Newsgroup.