aboutsummaryrefslogtreecommitdiff
path: root/lib/notmuch.h
diff options
context:
space:
mode:
authorHugo Osvaldo Barrera <hugo@whynothugo.nl>2026-02-09 20:04:42 +0100
committerDavid Bremner <david@tethera.net>2026-02-16 07:20:22 +0900
commitb8fa14f8a8f3e30c95f1dad54daa79a6a962fa73 (patch)
treebefcd460c1eb51118dc09b5c17c32dc8172bb7b0 /lib/notmuch.h
parent2ddff9923e09e379bce30cdb0f620b56fa7cea5e (diff)
Document that indexing does not sync flags
This quirk is somewhat unexpected, since flags won't be updated as expected, but subsequence calls to notmuch-new(1) won't update the index, giving an impression of it being stale.
Diffstat (limited to 'lib/notmuch.h')
-rw-r--r--lib/notmuch.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h
index ee11400a..dc40c886 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -807,6 +807,12 @@ notmuch_database_get_directory (notmuch_database_t *database,
* notmuch_message_destroy when done with the message. On any failure
* '*message' will be set to NULL.
*
+ * Note that this does not synchronise Maildir flags to notmuch flags,
+ * regardless of the value of maildir.synchronize_flags. Future calls to
+ * notmuch-new(1) will also not synchronise flags, since the file's current
+ * mtime shall be recorded as indexed. If flags ought to be synchronised,
+ * explicitly call notmuch_message_maildir_flags_to_tags.
+ *
* Return value:
*
* NOTMUCH_STATUS_SUCCESS: Message successfully added to database.