alter-flags

Arguments: mailbox messages &key flags add-flags remove-flags silent uid

This function changes the flags of the messages in the specified way. Exactly one of flags, add-flags, and remove-flags must be specified.

flags specifies the complete set of flags to be stored in the messages and the other two add or remove flags. If uid is true then messages will be interpreted as unique ids rather than message sequence numbers.

Normally alter-flags returns a data structure that describes the state of the flags after the alteration has been done. This data structure can be examined with the fetch-field function. But if silent is true then this data structure won't be created thus saving some time and space.

Removing a message from a mailbox is done by adding the :\\deleted flag to the message and then either calling close-mailbox or expunge-mailbox.

See imap.htm for more information.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.