set flags

This block is part of the imap group and was last modified in core v15.0.1.

set flags imapconnection v15.0.1

Marks messages read, unread, flagged, answered : or with a keyword of your own : by UID.

In pins 6 + flow

flow
flow
connection required
imapconnection
mailbox
value
Mailbox the uids belong to. Defaults to INBOX.
Default INBOX
uids
array
UIDs to change.
uid
number
A single UID, added to uids.
action
value
add (default), remove or set. • Suggestions: add remove set
Default add
flags required
array
seen, answered, flagged, deleted, draft, or a keyword such as $Forwarded.

Out pins 4 + flow

flow
flow
connection
imapconnection
success
condition
error
value
count
number

Runs UID STORE on the uids in mailbox (default INBOX). action: 'add' (default) adds the flags, 'remove' clears them, 'set' REPLACES every flag on the message. flags is an array of 'seen', 'answered', 'flagged', 'deleted', 'draft', the IMAP spelling ('\\Seen') or a keyword ('$Forwarded', 'Invoiced'). To mark as read: action add, flags [seen]; to mark unread: action remove, flags [seen]. count reports the uids the command covered. Suppressed in a simulation.

mark read

mark unread

flag email

imap store

A typical wiring for set flags: a function trigger starts the flow; move messages feeds the connection pin; with values feeds the flags pin; the flow out pin feeds debug.

Version history

Introduced in v15.0.1.

Back to imap Return to the main group to view all sub-groups Back to imap Return to the group to view all blocks within this group