Lumail - The console email client

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

Getting Started

Once you've downloaded and installed the client you'll want to create your own personal configuration file.

To allow smooth upgrades it is recommended you do not edit the global configuration file /etc/lumail/lumail.lua. Instead you should copy the sample user-configuration file into a suitable location.

On startup lumail will attempt to read from each of the following locations:

If you're not sure which location to use then this is simple, portable, and reliable:

  $ mkdir ~/.lumail/
  $ cp user.config.lua ~/.lumail/lumail.lua

If you're running lumail on multiple hosts then naming your configuration file after the hostname is perhaps a saner choice:

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

The defaults in that per-user configuration-file should be adequate, 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 to specify some aditional options, similarly if you wish to use encryption you should also read the GPG notes.

Using Lumail

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:

Once you've gotten started you'll want to consult the available Lua API to understand how the main configuration file operates, and what kind of things you can add to your own configuration file.

There is a small, but growing, list of example Lua available upon this website too.