Excel Add-In for Email

Build 25.0.9539

SetFlags

Adds, removes, or replaces existing flags with the specified flags.

Input

Name Type Description
Mailbox String The mailbox where the message is located.

The default value is Inbox.

Id String This inputs indicates the set of messages to operate on. It may consist of a single message id, a range of messages specified by two message numbers separated by ':' (e.g. '1:5'), and/or individual message numbers separated by ',' (e.g. '1:5,7,10').
Flags String Specifies the flags to apply to the target messages, provided as a comma-separated list (e.g., Seen,Deleted). Standard IMAP flags include Seen, Answered, Flagged, Deleted, Draft, and Recent, though servers may also support custom flags.

The default value is Seen.

OperationType String Specifies whether the provided flags should be added to, removed from, or used to replace the existing flag list.

The allowed values are ADD, REPLACE, REMOVE.

The default value is REPLACE.

Result Set Columns

Name Type Description
Success String Boolean response indicating whether or not the operation was successful.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539