notmuch/lib/notmuch.h, branch 0.9_rc1

lib: Improve notmuch_database_{add,remove}_message documentation.

2011-09-24T23:00:29Z

State up front that these functions may add a filename to an existing message or remove only a filename (and not the message), respectively. Previously, this key information was buried in return value documentation or in "notes", which made it seem secondary to these functions' semantics.

lib: Add an API to find a message by filename.

2011-09-24T23:00:28Z

notmuch_database_find_message_by_filename is mostly stolen from notmuch_database_remove_message, so this patch also vastly simplfies the latter using the former. This API is also useful in its own right and will be used in a later patch for eager maildir flag synchronization.

lib: Add support for nested atomic sections.

2011-09-24T01:50:38Z

notmuch_database_t now keeps a nesting count and we only start a transaction or commit for the outermost atomic section. Introduces a new error, NOTMUCH_STATUS_UNBALANCED_ATOMIC.

lib: Add notmuch_database_{begin,end}_atomic.

2011-09-24T01:50:38Z

These operations translate into non-flushed Xapian transactions, allowing arbitrary groups of database operations to be performed atomically.

fix sum moar typos [comments in source code]

2011-06-23T22:58:39Z

Various typo fixes in comments within the source code. Signed-off-by: Pieter Praet Edited-by: Carl Worth Restricted to just source-code comments, (and fixed fix of "descriptios" to "descriptors" rather than "descriptions").

tags_to_maildir_flags: Fix to preserve existing, unsupported flags

2010-11-12T00:36:02Z

This is to prevent notmuch from destroying any information the user has encoded as flags in the maildir filename. Tests are also added to the test suite to verify the documented behavior.

notmuch_message_tags_to_maildir_flags: Do nothing outside of "new" and "cur"

2010-11-11T22:32:17Z

Some people use notmuch with non-maildir files, (for example, email messages in MH format, or else cool things like using sluk[*] to suck down feeds into a format that notmuch can index). To better support uses like that, don't do any renaming for files that are not in a directory named either "new" or "cur". [*] https://github.com/krl/sluk/

lib: Be honest in the documentation of the maildir functions

2010-11-11T12:51:55Z

I had originally hoped for better semantics, such as doing nothing in non-maildir directories, and preserving unknown maildir flags that happen to be present. We could still do those things, of course, but for now, remove them from the documentation since the implementation does not do these things yet.

lib: Document that absence of maildir flags can also remove/add tags

2010-11-11T11:40:19Z

Previously the documentation of notmuch_message_maildir_flags_to_tags suggested that the presence of a flag would cause tags to be added, (or in the case of "unread", removed). But the case of absent maildir flags was not explicitly described. What we actually want, is that for supported flags, the absence of the flag in all messages causes the corresponding tag to be removed, (or in the case of "unread", added). So document that explicitly. This is the case recently added to the test suite as a failing test, (so we'll need to do bug fixing before the documentation is honest here).

lib: Add new, public notmuch_message_get_filenames

2010-11-11T11:40:19Z

This augments the existing notmuch_message_get_filename by allowing the caller access to all filenames in the case of multiple files for a single message. To support this, we split the iterator (notmuch_filenames_t) away from the list storage (notmuch_filename_list_t) where previously these were a single object (notmuch_filenames_t). Then, whenever the user asks for a file or filename, the message object lazily creates a complete notmuch_filename_list_t and then: For notmuch_message_get_filename, returns the first filename in the list. For notmuch_message_get_filenames, creates and returns a new iterator for the filename list.