4D Internet Commands v16
IMAP_GetFlags
- 4D Internet Commands
-
- IC IMAP Review Mail
-
- IMAP4 Commands, Overview
- IMAP_Capability
- IMAP_CloseCurrentMB
- IMAP_CopyToMB
- IMAP_CreateMB
- IMAP_Delete
- IMAP_DeleteMB
- IMAP_Download
- IMAP_GetCurrentMB
- IMAP_GetFlags
- IMAP_GetMBStatus
- IMAP_GetMessage
- IMAP_GetPrefs
- IMAP_ListMBs
- IMAP_Login
- IMAP_Logout
- IMAP_MsgFetch
- IMAP_MsgInfo
- IMAP_MsgLst
- IMAP_MsgLstInfo
- IMAP_MsgNumToUID
- IMAP_RenameMB
- IMAP_Search
- IMAP_SetCurrentMB
- IMAP_SetFlags
- IMAP_SetPrefs
- IMAP_SubscribeMB
- IMAP_UIDToMsgNum
- IMAP_VerifyID
IMAP_GetFlags
| IMAP_GetFlags ( imap_ID ; startMsg ; endMsg ; msgFlagsArray ; msgNumArray ) -> Function result | ||||||||
| Parameter | Type | Description | ||||||
| imap_ID | Longint |
|
Reference to an IMAP login | |||||
| startMsg | Longint |
|
Start message number | |||||
| endMsg | Longint |
|
End message number | |||||
| msgFlagsArray | String array |
|
Flag values for each message | |||||
| msgNumArray | Longint array |
|
Array of message numbers | |||||
| Function result | Integer |
|
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.
Product: 4D Internet Commands
Theme: IC IMAP Review Mail
Number:
88869
Created: 4D Internet Commands 6.8.1
4D Internet Commands ( 4D Internet Commands v16)
