aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-folder.c
diff options
context:
space:
mode:
Diffstat (limited to 'camel/camel-folder.c')
-rw-r--r--camel/camel-folder.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index 129ca418ce..ca30bb24cd 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -756,10 +756,13 @@ set_message_flags(CamelFolder *folder, const char *uid, guint32 flags, guint32 s
* @flags: a set of CamelMessageFlag values to set
* @set: the mask of values in @flags to use.
*
- * Sets those flags specified by @set to the values specified by @flags
+ * Sets those flags specified by @flags to the values specified by @set
* on the indicated message. (This may or may not persist after the
* folder or store is closed. See camel_folder_get_permanent_flags().)
*
+ * E.g. to set the deleted flag and clear the draft flag, use
+ * set_message_flags(folder, uid, CAMEL_MESSAGE_DELETED|CAMEL_MESSAGE_DRAFT, CAMEL_MESSAGE_DELETED);
+ *
* Return Value: TRUE if the flags were changed, false otherwise.
**/
gboolean