Lumail - The console email client

Getting Started

Running make install will install the binary, the libraries that we bundle, and the perl-utilities which are required for IMAP-operation.

If you wish to install manually copy:

Once installed you'll then want to create your own personal configuration file.

To allow smooth upgrades it is recommended you do not edit the global configuration file /etc/lumail2/lumail2.lua. Instead you should copy the sample user-configuration file into place:

  $ mkdir ~/.lumail2/
  $ cp lumail2.user.lua ~/.lumail2/lumail2.lua

If you prefer you can name your configuration file after the hostname of the local system (which use useful if you store your "dotfiles" under revision control, and have the same configuration files stored on multiple hosts):

  $ mkdir ~/.lumail2/
  $ cp lumail2.user.lua ~/.lumail2/$(hostname --fqdn).lua

The defaults in the per-user configuration file should be adequately documented, but in-brief you'll want to ensure you set at least the following:

 -- Set the location of your Maildir folders, and your sent-folder
 Config:set( "maildir.prefix", os.getenv( "HOME" ) .. "/Maildir/" );
 Config:set( "global.sent-mail", os.getenv( "HOME" ) .. "/Maildir/sent/" )

 -- Set your outgoing mail-handler, and email-address:
 Config:set( "global.mailer", "/usr/lib/sendmail -t" )
 Config:set( "global.sender", "Some User <>" )

 -- Set your preferred editor
 Config:set( "global.editor", "vim  +/^$ ++1 '+set tw=72'" )

Other options are possible, and you'll find if you wish to use IMAP you need some more options. If you wish to use encryption you should also read the GPG notes.

Using Lumail2

By default you'll be in the maildir-mode, and you can navigate with j/k, and select items with ENTER.

For a quick-start you can use the following bindings: