4D v13.2

IMAP_GetFlags

Home

 
4D v13.2
IMAP_GetFlags

IMAP_GetFlags 


 

IMAP_GetFlags ( imap_ID ; startMsg ; endMsg ; msgFlagsArray ; msgNumArray ) -> Function result 
Parameter Type   Description
imap_ID  Longint in Reference to an IMAP login
startMsg  Text in Start message number
endMsg  Text in End message number
msgFlagsArray  String array in Flag values for each message
msgNumArray  Longint array in Array of message numbers
Function result  Integer in Error code

The IMAP_GetFlags command returns the list of flags for the specified messages.

imap_ID is a long integer reference to an open connection created with IMAP_Login.

startMsg is a long integer number that specifies the starting message number of the message range to be examined. The message number is a value representing the position of a message within the list of all messages in the current working mailbox.

endMsg is a long integer number that specifies the ending message number of the message range to be examined. The message number is a value representing the position of a message within the list of all messages in the current working mailbox.

Note: The IMAP_Delete, IMAP_MsgLstInfo, IMAP_MsgLst, IMAP_SetFlags, IMAP_GetFlags and IMAP_CopyToMB commands do not return an error if the startMsg is greater than the endMsg. In the event that this occurs, the command — in effect — does nothing.

msgFlagsArray is a string or text array returned containing the list of flags, separated by spaces, of each message number between startMsg and endMsg.

msgNumArray is a long integer array returned containing the message numbers between startMsg and endMsg.

 
PROPERTIES 

Product: 4D
Theme: IC IMAP Review Mail
Number: 88869

 
INDEX

Alphabetical list of commands

 
HISTORY 

Created: 4D Internet Commands 6.8.1

 
SEE ALSO 

IMAP_SetCurrentMB
IMAP_SetFlags