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