astroid mua

A graphical threads-with-tags mail user agent inspired by sup and notmuch. Written in C++ using GTK+, WebKit and gmime.

getting started

Astroid is a Mail User Agent. As such, all Astroid provides is a graphical interface to your email. Thus, Astroid enables you to launch actions that rely on the performance of other programs to actually fetch, sync, index, search and send your email. A suggested setup is described in the wiki.

Check out the tour of how to install, configure and use astroid. Brief instructions are provided below.

main features include:

(done) fully operatable by keyboard only - but accept mouse clicks
```
          lightweight.
```
(partly done) a graphical interface, inspired by sup. but allow buffers to be separeted and placed in several windows.
(done) allow several simultaneous windows.
(done) display html mail and some attachments inline.
(done) render math using MathJax
(done) syntax highlighting between triple-backtick tags (markdown style)
(done) themable and configurable
(in progress) built-in crypto (gpg,..) support.
(only vim) editors: embed vim or emacs (possibly ship a simple editor)
(linux) Support: Platforms supported by notmuch and other libraries, specifically: Linux, *BSD, Mac, Windows..

more screenshots

acquiring astroid

get astroid from:

$ git clone https://github.com/gauteh/astroid.git

installation and usage

compiling

$ scons

to run the tests do:

$ scons test

installing

Configure with a prefix and install:

$ scons --prefix=/usr build
$ scons --prefix=/usr install

this will install the astroid binary into /usr/bin/ and data files into /usr/share/astroid/. refer to the installing section in the wiki for more information.

configuration

running astroid will make a new configuration file in $XDG_CONFIG_HOME/astroid (normally: ~/.config/astroid/. refer to the configuration section in the wiki for more information.

running and usage

$ ./astroid

press ? to get a list of available key bindings in the current mode, navigate up and down using j and k. refer to the usage section in the wiki for more information on usage and customization.

patches, help, comments and bugs

Report on the github page or to the mailinglist at: astroidmail@googlegroups.com, subscribe online or by sending an email to: astroidmail+subscribe@googlegroups.com.

Contributions to Astroid in the form of patches, documentation and testing are very welcome. Information on how to contribute to astroid can be found in the wiki.

Also check out #astroid or #notmuch on irc.freenode.net.

acknowledgements

The main inspiration for astroid is the sup mail user agent. sup provided inspiration for notmuch which is a mail indexer. astroid is using notmuch as a backend.

Some parts of the user interface and layout have been copied from or has been inspired by the Geary mail client. One of the other notmuch email clients, ner, has also used for inspiration and code.

licensing

See LICENSE.md for licensing information.

fossilalien/astroid