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