https://github.com/davidmstraub/netviel

Web interface for the notmuch e-mail system
https://github.com/davidmstraub/netviel

Last synced: 2 days ago
JSON representation

Web interface for the notmuch e-mail system

• Host: GitHub
• URL: https://github.com/davidmstraub/netviel
• Owner: DavidMStraub
• License: mit
• Created: 2019-10-16T13:39:07.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-30T18:31:50.000Z (over 1 year ago)
• Last Synced: 2024-10-14T06:52:13.451Z (about 1 month ago)
• Language: Python
• Size: 947 KB
• Stars: 54
• Watchers: 5
• Forks: 12
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# net viel

net viel [nɛt fiːl] ([Swabian](https://en.wikipedia.org/wiki/Swabian_German) for "not much") allows searching through an e-mail archive indexed with [`notmuch`](https://notmuchmail.org/) from a browser.

The original idea (of which it falls way short) was to search e-mails in a local Maildir with the convenience of a GMail-like interface.

Technically, it is a single-page web app (based on the [Open WC Starter App](https://github.com/open-wc/open-wc-starter-app)) with a Python REST API as backend served with [Flask](https://palletsprojects.com/p/flask/).

## Installation

```

python3 -m pip install netviel --user

```

## Screenshots

![](netviel.gif)

(Nonsensical e-mails generated with the help of [Faker](https://github.com/joke2k/faker).)

## Demo

[See here for a demo instance](https://glacial-castle-83891.herokuapp.com/) with random e-mails (but no attachments or HTML e-mails, which net viel supports as well).

Note that the initial startup of the demo could take up to half a minute until the Heroku dyno (free tier) wakes up, after that it should be snappy.

## Requirements

You need to have `notmuch` installed with its Python bindings. On Debian-based systems, this is achieved with

```

sudo apt install notmuch python3-notmuch

```

Python 3.6 or above is required.

## Usage

The web interface accessing your local `notmuch` database is opened simply with

```

python3 -m netviel

```

The Flask default port 5000 can be changed with the `--ports` option.

**:warning: net viel is meant for *local* use only. Do *not* expose this to the Internet as-is. Bad things will happen! :warning:**

## Development

To run net viel locally and make changes to the code, follow intructions on [this page](docs/developers.md).