Lumail - The console email client

This project is now archived, and "complete". See #361 for more details.


Lumail is deliberately designed to only depend upon a small number of libraries, to ensure that it is possible to build it upon the widest range of systems.

The code has only been tested by the authors upon GNU/Linux, but if it fails to build upon OpenBSD, FreeBSD, or any other similar modern Unix flavour this is a bug and should be reported as such.


As of the current release the dependencies are as follows:

Upon a Debian GNU/Linux system you may install the dependencies with:

 # apt-get install build-essential make pkg-config
 # apt-get install liblua5.2-dev libgmime-2.6-dev libncursesw5-dev libpcre3-dev libmagic-dev

Compiling & Installing

Providing you have the appropriate dependencies installed you can build the client via a single "make" command:

$ make

Running make install will install the binary, the libraries that we bundle, and the IMAP-proxy which is required for accesing IMAP accounts.

If you wish to install manually copy:

  • The contents of lib/ to /usr/lib/lumail.
  • The contents of perl.d to /usr/share/lumail.

At this point you should continue to the get started guide.

Changed Locations

In the past our Lua support-code, and libraries were deployed beneath /etc/lumail2/lib - This is now obsolete, as is /etc/lumail2/perl.d/.

If you've not made changes to those files you are safe to remove them, which will prevent a warning on-startup.

Executing the Test Suite

Once installed you should be able to execute the included test-suite, by running:

lumail2 --test