Documentation
Due to the recent reworking, which lead to lumail v2.x, the documentation has been split into two parts:
Lumail 2.x
Lumail 2.x is a ground-up rewrite of the previous application, and features a minimal and unified API for scripting the client.
The scripting is still Lua-based, but the object methods have been simplified and implemented as a cohesive set of modules, methods, and variables.
Our getting started guide provides a simple introduction to installing, and configuring lumail.
- Command-line flags
The lumail2 client accepts several command-line flags, which this page documents.
- Read the GPG overview
This section describes the GPG support in Lumail.
- Read the IMAP overview
This describes the history behind the IMAP implementation, has notes on dependencies, and a sample configuration snippet to use.
- Read about the Lumail 2.x API
The API-page describes all the objects that are supported and implemented in the 2.x API, along with links to sample code.
- The default configuration file
The default configuration file is a great example of the configuration you might enjoy.
Lumail-Legacy
NOTE: Lumail-legacy has been superseded by Lumail 2.x, which has a wholly unified Lua API.
- Command-line flags
The lumail client accepts several command-line flags, which this page documents.
- The default configuration file
The default configuration file gives a flavour of how the software can be configured. It also documents the default keybindings.
- The examples page
The example page includes several functions you could add to your own configuration file, to do interesting things with your mail.
- External input processing.
- As of v0.25 lumail can read input from a Unix domain socket, and this page shows how.
- The getting started guide
The getting-started guide gives a basic overview of the client, and introduces you to using it.
- Lua primitives
Each of the Lua primitives that lumail provides is documented, usually with an example.