Notmuch Web Client
- Search messages -
search screenshot and
- link default searches from the navigation bar
- view results in a table, with customizable buttons for retagging each thread
- view results in a pager, which shows the thread content together with a navigation bar with "Next" button plus tagging buttons.
- Opensearch.xml integration, so you can add notmuch-web as a search engine to your web browser.
- View individual threads
- a visible tree structure and the ability to collapse individual messages
- download attachments from messages
- customizable tagging buttons on each message
- Compose email
- sending with attachments
- supports reply and reply all
- for compose, I recommend Its All Text to use your favorite editor.
- Execute a raw notmuch command and view the results
To quickly test out the client on linux, make sure you have libgmp and zlib installed, download the latest binary, extract the tarball, then run
$ mv config/settings.example.yml config/settings.yml $ ./notmuch-web Testing
You can now visit http://localhost:3000 and use "hunter2" as the password.
One nice feature of GHC (the Haskell compiler) is the ability to statically link binaries to not require Haskell to be installed. I have therefore built the latest release; you can find the tarballs on the download page. The only prerequisites are glibc, libgmp, and zlib.
Source, latest released version
$ cabal update $ cabal install yesod-platform notmuch-web
You must mention both yesod-platform and notmuch-web on the same install line to make sure all dependencies are resolved correctly, otherwise you will get an error.
The binary will appear at ~/.cabal/bin/notmuch-web and the configuration files (see below) are in ~/.cabal/share/notmuch-web-version
Source, from bitbucket
To compile from bitbucket, install the Haskell Platform, run "cabal update", then run "cabal install yesod-platform". Next, clone from bitbucket and within the notmuch-web directory, run "cabal install --only-dependencies". You can now run "yesod devel" to start the development server or use the package.sh script to build a tarball. You might investigate cabal-dev or hsenv to have an isolated build environment.
When launching the notmuch-web binary, it expects several files to be located in two subdirectories of the current directory. No other configuration or install is needed, so you can copy the notmuch-web binary and these two folders anywhere, even deploy on computers with no Haskell installed.
Second, a (modified) copy of the "config" folder must be in the current directory. The config folder must contain:
- robots.txt - this file is served as robots.txt as the root and by default denies all search engines. You can edit to your taste.
- favicon.ico - this is served as the favicon and defaults to the notmuch favicon. You can replace with your own icon if you like.
- client_session_key.aes - notmuch-web uses AES encrypted cookies to store session information and the AES key is stored in this file. If the file does not exist a new key is randomly generated and placed in this file. Make sure you keep this file private.
- settings.yml - the yaml file containing all the configuration. The binary tarballs contain a file settings.yml.example which should be copied to settings.yml. See the next section for the settings.
notmuch-web has four modes: Development, Testing, Staging, and Production. The mode is specified on the command line when launching notmuch-web. The settings.yml file is split into four sections, one for each mode and notmuch-web will only load settings from the matching section of settings.yml. Using yaml references a collection of default settings are copied into each section of the configuration.
The default settings.yml file is well commented so I won't explain it here. The only required setting that must be edited before notmuch-web will run is "hashed-password", the hash of the password to access (see pwstore for the format). You can generate the hashed password by running "notmuch-web --make-password". Other settings like "from-address" and "approot" should be set as well for proper operation.
To run, execute "notmuch-web Production". This will start the server listening on the configured port. notmuch-web accesses notmuch by launching the "notmuch" binary found in the PATH, so you must make sure the user running notmuch-web has notmuch in the PATH, is able to access the email directory, and has a valid notmuch configuration. You might need to set the NOTMUCH_CONFIG environment variable before launching notmuch-web.
I use a systemd unit to start notmuch-web as my login user at boot, having notmuch-web listen on port 3000. I then run nginx with SSL on port 443, and have nginx reverse proxy to notmuch-web.
Currently, notmuch-web does not implement SSL (although since Yesod/Warp supports SSL we could support it without too much work so it is on the TODO list). Therefore, you will want to reverse-proxy notmuch-web. I use nginx.
When you send a message, notmuch-web sends it using the executable "sendmail" located in PATH. If you are not running your own email server, I suggest msmtp. I use msmtp on my laptop, it works great. Just make sure the user you run notmuch-web has the correct msmtp configuration setup.