AddMessageFlags Method

Adds the specified flags to the messages specified by MessageSet .

Syntax

ANSI (Cross Platform)
int AddMessageFlags(const char* lpszFlags);

Unicode (Windows)
INT AddMessageFlags(LPCWSTR lpszFlags);
- (void)addMessageFlags:(NSString*)flags;
#define MID_IMAP_ADDMESSAGEFLAGS 2

IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_IMAP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method adds the specified flags to the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but can include:

\Deleted Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen Mark a message as read.
\Answered Mark a message as answered.
\Flagged Mark a message as flagged.
\Draft Mark a message as being incomplete (under composition).

Example (Setting Adding Message Flags)


IMAPControl.MessageSet = "1"
IMAPControl.AddMessageFlags("\Deleted")

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 C++ Edition - Version 20.0 [Build 8307]