git.notmuchmail.org Git - notmuch/blob - 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 2. Allow an easy way to get tags from directory names (if the user has them)
   6
   7 Emacs interface (notmuch.el)
   8 ----------------------------
   9 Enhance '+' and '-' in the search view to operate on an entire region
  10 if set.
  11
  12 Fix '*' to work by simply calling '+' or '-' on a region consisting of
  13 the entire buffer.
  14
  15 Add a global keybinding table for notmuch, and then view-specific
  16 tables that add to it.
  17
  18 Add a '|' binding from the search view.
  19
  20 Add support for choosing from one of the user's configured email
  21 addresses for the From line.
  22
  23 Make 'notmuch-show-pipe-message have a private history.
  24
  25 Add support for a delete keybinding that adds a "deleted" tag to the
  26 current message/thread and make searches not return deleted messages
  27 by default, (unless the user asks explicitly for deleted messags in
  28 the search query).
  29
  30 Add support to "mute" a thread (add a "muted" tag and then don't
  31 display threads in searches by default where any message of the thread
  32 has the "muted" tag).
  33
  34 Fix i-search to open up invisible citations as necessary.
  35
  36 Make '=' count from the end rather than from the beginning if more
  37 than half-way through the buffer.
  38
  39 Emacs saved-search interface
  40 ----------------------------
  41 Here's a proposal Carl wrote (id:87einafy4u.fsf@yoom.home.cworth.org):
  42
  43   So what I'm imagining for the default notmuch view is something like
  44   this:
  45
  46           Welcome to notmuch.
  47
  48               Notmuch search: _________________________________________
  49
  50           Saved searches:
  51
  52               55,342      All messages
  53                   22      Inbox
  54
  55           Recent searches:
  56
  57                    1      from:"someone special" and tag:unread
  58                   34      tag:notmuch and tag:todo
  59
  60           Click (or press Enter) on any search to see the results.
  61           Right-click (or press Space) on any recent search to save it.
  62
  63   So the "saved searches" portion of the view is basically just what
  64   notmuch-folder displays now. Above that there's an obvious place to
  65   start a new search, (in a slightly more "web-browser-like" way than the
  66   typical mini-buffer approach).
  67
  68   All recent searches appear in the list at the bottom automatically, and
  69   there's the documented mechanism for saving a search, (giving it a name
  70   and having it appear above).
  71
  72 Portability
  73 -----------
  74 Fix configure script to test each compiler warning we want to use.
  75
  76 Completion
  77 ----------
  78 Fix bash completion to complete multiple search options (both --first
  79 and *then* --max-threads), and also complete value for --sort=
  80 (oldest-first or newest-first).
  81
  82 notmuch command-line tool
  83 -------------------------
  84 Fix the --format=json option to not imply --entire-thread.
  85
  86 Implement "notmuch search --exclude-threads=<search-terms>" to allow
  87 for excluding muted threads, (and any other negative, thread-based
  88 filtering that the user wants to do).
  89
  90 Fix "notmuch show" so that the UI doesn't fail to show a thread that
  91 is visible in a search buffer, but happens to no longer match the
  92 current search. (Perhaps add a --matching=<secondary-search-terms>
  93 option (or similar) to "notmuch show".) For now, this is being worked
  94 around in the emacs interface by noticing that "notmuch show" returns
  95 nothing and re-rerunning the command without the extra arguments.
  96
  97 Teach "notmuch search" to return many different kinds of results. Some
  98 ideas:
  99
 100         notmuch search --output=threads # Default if no --output is given
 101         notmuch search --output=messages
 102         notmuch search --output=tags
 103         notmuch search --output=addresses
 104         notmuch search --output=terms
 105
 106 Add a "--format" option to "notmuch search", (something printf-like
 107 for selecting what gets printed).
 108
 109 Add a "--count-only" (or so?) option to "notmuch search" for returning
 110 the count of search results.
 111
 112 Give "notmuch restore" some progress indicator.
 113
 114 Fix "notmuch restore" to operate in a single pass much like "notmuch
 115 dump" does, rather than doing N searches into the database, each
 116 matching 1/N messages.
 117
 118 Add a "-f <filename>" option to select an alternate configuration
 119 file.
 120
 121 Allow configuration for filename patterns that should be ignored when
 122 indexing.
 123
 124 Replace the "notmuch part --part=id" command with "notmuch show
 125 --part=id", (David Edmonson wants to rewrite some of "notmuch show" to
 126 provide more MIME-structure information in its output first).
 127
 128 Replace the "notmuch search-tags" command with "notmuch search
 129 --output=tags".
 130
 131 Fix to avoid this ugly message:
 132
 133         (process:17197): gmime-CRITICAL **: g_mime_message_get_mime_part: assertion `GMIME_IS_MESSAGE (message)' failed
 134         Warning: Not indexing empty mime part.
 135
 136   This probably means adding a test case to generate that message,
 137   filing an upstream bug against GMime, and then silencing the
 138   notmuch-generated portion of the warning (so that once GMime is
 139   fixed, this is all silent).
 140
 141 notmuch library
 142 ---------------
 143 Add an interface to accept a "key" and a byte stream, rather than a
 144 filename.
 145
 146 Provide a sane syntax for date ranges. First, we don't want to require
 147 both endpoints to be specified. For example it would be nice to be
 148 able to say things like "since:2009-01-1" or "until:2009-01-1" and
 149 have the other endpoint be implicit. Second we'd like to support
 150 relative specifications of time such as "since:'2 months ago'". To do
 151 any of this we're probably going to need to break down an write our
 152 own parser for the query string rather than using Xapian's QueryParser
 153 class.
 154
 155 Make failure to read a file (such as a permissions problem) a warning
 156 rather than an error (should be similar to the existing warning for a
 157 non-mail file).
 158
 159 Actually compile and install a libnotmuch shared library.
 160
 161 Fix to use the *last* Message-ID header if multiple such headers are
 162 encountered, (I noticed this is one thing that kept me from seeing the
 163 same message-ID values as sup).
 164
 165 Add support for configuring "virtual tags" which are a tuple of
 166 (tag-name, search-specification). The database is responsible for
 167 ensuring that the virtual tag is always consistent.
 168
 169 Indicate to the user if two files with the same message ID have
 170 content that is actually different in some interesting way. Perhaps
 171 notmuch initially sees all changes as interesting, and quickly learns
 172 from the user which changes are not interesting (such as the very
 173 common mailing-list footer).
 174
 175 Fix notmuch_query_count_messages to share code with
 176 notmuch_query_search_messages rather than duplicating code. (And
 177 consider renaming it as well.)
 178
 179 Provide a mechanism for doing automatic address completion based on
 180 notmuch searches. Here was one proposal made in IRC:
 181
 182         <cworth> I guess all it would really have to be would be a way
 183                  to configure a series of searches to try in turn,
 184                  (presenting ambiguities at a given single level, and
 185                  advancing to the next level only if one level
 186                  returned no matches).
 187         <cworth> So then I might have a series that looks like this:
 188         <cworth> notmuch search --output=address_from tag:address_book_alias
 189         <cworth> notmuch search --output=address_to tag:sent
 190         <cworth> notmuch search --output=address_from
 191         <cworth> I think I might like that quite a bit.
 192         <cworth> And then we have a story for an address book for
 193                  non-emacs users.
 194
 195 Provide a ~me Xapian synonym for all of the user's configured email
 196 addresses.
 197
 198 Database changes
 199 ----------------
 200 Store a reference term for every message-id that appears in
 201 References. We just started doing this for newly-added documents, but
 202 at the next convenient database-schema upgrade, we should go back and
 203 fix old messages to be consistent.
 204
 205 Start indexing the List-Id header, (and re-index this header for
 206 existing messages at the next database upgrade).
 207
 208 Start indexing the message file's directory ana make it available for
 209 search as "folder:" (and re-index this value for existing messages at
 210 the next database upgrade).
 211
 212 Add support for the user to specify custom headers to be indexed (and
 213 re-index these for existing messages at the next database upgrade).
 214
 215 Test suite
 216 ----------
 217 Start testing --format=json.
 218
 219 Achieve 100% test coverage with the test suite.
 220
 221 Modularize test suite (to be able to run individual tests).
 222
 223 Summarize test results at the end.
 224
 225 Fix the insane quoting nightmare of the test suite, (and once we do
 226 that we can actually test the implicit-phrase search feature such as
 227 "notmuch search 'body search (phrase)'"
 228
 229 Test "notmuch reply" choosing the correct email address from the
 230 Received header when no configured email address appears in To or Cc.
 231
 232 General
 233 -------
 234 Audit everything for dealing with out-of-memory (and drop xutil.c).
 235
 236 Investigate why the notmuch database is slightly larger than the sup
 237 database for the same corpus of email.