git.notmuchmail.org Git - notmuch/blob - devel/TODO

   1 Fix the things that are causing the most pain to new users
   2 ----------------------------------------------------------
   3 1. A new import is tagging all messages as "inbox" -- total pain
   4
   5 Emacs interface (notmuch.el)
   6 ----------------------------
   7 Add notmuch-bcc and notmuch-cc for setting default Bcc and Cc values,
   8 (should affect the message-setup-hook).
   9
  10 Switch the notmuch-search view to use "notmuch search --format=json"
  11 to fix large classes of bugs regarding poorly-escaped output and lame
  12 regular expressions. (The most recently found, unfixed example is the
  13 sender's name containing ';' which causes emacs to drop a search
  14 result.) This may require removing the outer array from the current
  15 "notmuch search --format=json" results.
  16
  17 Fix '*' to work by simply calling '+' or '-' on a region consisting of
  18 the entire buffer, (this would avoid one race condition---while still
  19 leaving other race conditions---but could also potentially make '*' a
  20 very expensive operation).
  21
  22 Add a global keybinding table for notmuch, and then view-specific
  23 tables that add to it.
  24
  25 Add a '|' binding from the search view.
  26
  27 Add support for choosing from one of the user's configured email
  28 addresses for the From line.
  29
  30 Make 'notmuch-show-pipe-message have a private history.
  31
  32 Add support for a delete keybinding that adds a "deleted" tag to the
  33 current message/thread and make searches not return deleted messages
  34 by default, (unless the user asks explicitly for deleted messages in
  35 the search query).
  36
  37 Add keybindings for next/previous thread.
  38
  39 Add support to "mute" a thread (add a "muted" tag and then don't
  40 display threads in searches by default where any message of the thread
  41 has the "muted" tag).
  42
  43 Make '=' count from the end rather than from the beginning if more
  44 than half-way through the buffer.
  45
  46 Fix to automatically wrap long headers (for RFC compliance) before
  47 sending. This should probably just be fixed in message-mode itself,
  48 (but perhaps we can have a notmuch-message-mode that layers this on
  49 top).
  50
  51 Stop hiding the headers so much in the thread-view mode.
  52
  53 Allow opening a message in thread-view mode by clicking on either
  54 line.
  55
  56 Automatically open a message when navigating to it with N or P.
  57
  58 Change 'a' command in thread-view mode to only archive open messages.
  59
  60 notmuch command-line tool
  61 -------------------------
  62 Add support to "notmuch search" and "notmuch show" to allow for
  63 listing of duplicate messages, (distinct filenames with the same
  64 Message-ID). I'm not sure what the option should be named. Perhaps
  65 --with-duplicates ?
  66
  67 Replace "notmuch reply" with "notmuch compose --reply <search-terms>".
  68 This would enable a plain "notmuch compose" to be used to construct an
  69 initial message, (which would then have the properly configured name
  70 and email address in the From: line. We could also then easily support
  71 "notmuch compose --from <something>" to support getting at alternate
  72 email addresses.
  73
  74 Implement "notmuch search --exclude-threads=<search-terms>" to allow
  75 for excluding muted threads, (and any other negative, thread-based
  76 filtering that the user wants to do).
  77
  78 Fix "notmuch show" so that the UI doesn't fail to show a thread that
  79 is visible in a search buffer, but happens to no longer match the
  80 current search. (Perhaps add a --matching=<secondary-search-terms>
  81 option (or similar) to "notmuch show".) For now, this is being worked
  82 around in the emacs interface by noticing that "notmuch show" returns
  83 nothing and re-rerunning the command without the extra arguments.
  84
  85 Add a "--format" option to "notmuch search", (something printf-like
  86 for selecting what gets printed).
  87
  88 Give "notmuch restore" some progress indicator.
  89
  90 Fix "notmuch restore" to operate in a single pass much like "notmuch
  91 dump" does, rather than doing N searches into the database, each
  92 matching 1/N messages.
  93
  94 Allow configuration for filename patterns that should be ignored when
  95 indexing.
  96
  97 Fix to avoid this ugly message:
  98
  99         (process:17197): gmime-CRITICAL **: g_mime_message_get_mime_part: assertion `GMIME_IS_MESSAGE (message)' failed
 100         Warning: Not indexing empty mime part.
 101
 102   This probably means adding a test case to generate that message,
 103   filing an upstream bug against GMime, and then silencing the
 104   notmuch-generated portion of the warning (so that once GMime is
 105   fixed, this is all silent).
 106
 107 Simplify notmuch-reply to simply print the headers (we have the
 108 original values) rather than calling GMime (which encodes) and adding
 109 the confusing gmime-filter-headers.c code (which decodes).
 110
 111 Properly handle replying to multiple messages. Currently, the JSON
 112 reply format only supports a single message, but the default reply
 113 format accepts searches returning multiple messages. The expected
 114 behavior of replying to multiple messages is not obvious, and there
 115 are multiple ideas that might make sense. Some consensus needs to be
 116 reached on this issue, and then both reply formats should be updated
 117 to be consistent.
 118
 119 notmuch library
 120 ---------------
 121 Add support for custom flag<->tag mappings. In the notmuch
 122 configuration file this could be
 123
 124         [maildir]
 125         synchronize_flags = R:replied; D*:deleted; S:~unread;
 126
 127 In the library interface this could be implemented with an array of
 128 structures to define the mapping (flag character, tag name,
 129 inverse-sense bit (~ above), and tag-when-any-file-flagged
 130 vs. tag-when-all-files-flagged (* above)).
 131
 132 Add an interface to accept a "key" and a byte stream, rather than a
 133 filename.
 134
 135 Improve syntax for date ranges queries. date:expr should be
 136 interpreted as date:expr..expr so that, for example, "date:2013-01-22"
 137 would cover the whole of the specified day (currently that's not even
 138 recognized as a date range expression). It might be nice to be able to
 139 use things like "since:2013-01-22" and "until:2013-01-22" as synonyms
 140 to "date:2013-01-22.." and "date:..2013-01-22", respectively. To do
 141 any of this we're probably going to need to break down and write our
 142 own parser for the query string rather than using Xapian's QueryParser
 143 class.
 144
 145 Make failure to read a file (such as a permissions problem) a warning
 146 rather than an error (should be similar to the existing warning for a
 147 non-mail file).
 148
 149 Fix to use the *last* Message-ID header if multiple such headers are
 150 encountered, (I noticed this is one thing that kept me from seeing the
 151 same message-ID values as sup).
 152
 153 Add support for configuring "virtual tags" which are a tuple of
 154 (tag-name, search-specification). The database is responsible for
 155 ensuring that the virtual tag is always consistent.
 156
 157 Indicate to the user if two files with the same message ID have
 158 content that is actually different in some interesting way. Perhaps
 159 notmuch initially sees all changes as interesting, and quickly learns
 160 from the user which changes are not interesting (such as the very
 161 common mailing-list footer).
 162
 163 Fix notmuch_query_count_messages to share code with
 164 notmuch_query_search_messages rather than duplicating code. (And
 165 consider renaming it as well.)
 166
 167 Provide a mechanism for doing automatic address completion based on
 168 notmuch searches. Here was one proposal made in IRC:
 169
 170         <cworth> I guess all it would really have to be would be a way
 171                  to configure a series of searches to try in turn,
 172                  (presenting ambiguities at a given single level, and
 173                  advancing to the next level only if one level
 174                  returned no matches).
 175         <cworth> So then I might have a series that looks like this:
 176         <cworth> notmuch search --output=address_from tag:address_book_alias
 177         <cworth> notmuch search --output=address_to tag:sent
 178         <cworth> notmuch search --output=address_from
 179         <cworth> I think I might like that quite a bit.
 180         <cworth> And then we have a story for an address book for
 181                  non-emacs users.
 182
 183 Provide a ~me Xapian synonym for all of the user's configured email
 184 addresses.
 185
 186 Add symbol hiding so that we don't risk leaking any private symbols
 187 into the shared-library interface.
 188
 189 Audit all libnotmuch entry points to ensure that all Xapian calls are
 190 wrapped in a try/catch block.
 191
 192 Fix the "count" functionality to be exact as Olly explained in IRC:
 193
 194         ojwb> cworth: if you set the check_at_least parameter to the
 195         database size, get_matches_estimated() will be exact
 196
 197 Fix the threading of a message that has a References: header but no
 198 In-Reply-To: header (see id:"87lixxnxpb.fsf@yoom.home.cworth.org").
 199
 200 Search syntax
 201 -------------
 202 Implement support for "tag:*" to expand to all tags.
 203
 204 Fix "notmuch search to:" to be less confusing. Many users expect this
 205 to search for all messages with a To: header, but it instead searches
 206 for all messages with the word "to". If we don't provide the first
 207 behavior, perhaps we should exit on an error when a configured prefix
 208 is provided with no value?
 209
 210 Support "*" in all cases and not just as a special case. That is, "* "
 211 should also work, as well as "* and tag:inbox".
 212
 213 Implement a syntax for requesting set-theoertic operations on results
 214 of multiple searches. For example, I would like to do:
 215
 216         "tag:inbox" SET-SUBTRACT "tag:muted"
 217
 218     as well as:
 219
 220         "tag:notmuch and <date-range>" SET-INTERSECT
 221         "tag:notmuch and not (tag:merged or tag:postponed)"
 222
 223     See id:3wdpr282yz2.fsf@testarossa.amd.com for more details on the
 224     use cases of the above.
 225
 226 Database changes
 227 ----------------
 228 Store a reference term for every message-id that appears in
 229 References. We just started doing this for newly-added documents, but
 230 at the next convenient database-schema upgrade, we should go back and
 231 fix old messages to be consistent.
 232
 233 Start indexing the List-Id header, (and re-index this header for
 234 existing messages at the next database upgrade).
 235
 236 Add support for the user to specify custom headers to be indexed (and
 237 re-index these for existing messages at the next database upgrade).
 238
 239 Save filenames for files detected as "not an email file" in the
 240 database. This would allow for two things: 1. Optimizing "notmuch new"
 241 to not have to look at these files again (since they are potentially
 242 large so the detection could be potentially slow). 2. A "notmuch
 243 search" syntax could be added to allow the user to find these files,
 244 (and perhaps delete them or move them away as appropriate).
 245
 246 Fix filesystem/notmuch-new race condition by not updating database
 247 mtime for a directory if it is the same as the current mtime.
 248
 249 Test suite
 250 ----------
 251 Achieve 100% test coverage with the test suite.
 252
 253 General
 254 -------
 255 Audit everything for dealing with out-of-memory (and drop xutil.c).
 256
 257 Investigate why the notmuch database is slightly larger than the sup
 258 database for the same corpus of email.
 259
 260 Makefile should print message teaching user about LD_LIBRARY_PATH (or
 261 similar) if libdir is not set to a directory examined by ldconfig.