Lumail - The console email client

Command-Line arguments

The client accepts several command-line arguments, the precise flags will depend upon the version of lumail you're running.

Lumail 2.x

--folder "path"

Open the given folder, and switch to index-mode on startup.

--load-file "path/to/code.lua"

Load the specified configuration/Lua file, on-startup..


Disable the curses-output; this is mostly useful for loading sample configuration file-snippets to test them, as it will enable the Lua print function to work as expected.


Execute the internal test-suite, which is included in both release and debug builds.


Show the version number of your lumail2 binary, then exit.


NOTE: Lumail-legacy has been superseded by Lumail 2.x, which has a wholly unified Lua API.


If lumail has been compiled in debug-mode this option will allow you to specify the path to the debug-logfile. The logfile will contain "interesting events".

If you're running a debug-build and you don't specify a file then ~/lumail.log will be used by default.


Exit the application.

This is present so that you may exit after evaluating an expression with the --eval flag.

--eval "string"

Evaluate the given Lua expression, or function. It is assumed that the function to be executed will be one you've defined in your startup configuration file.

--folder "path"

Open the given folder, and switch to index-mode on startup.

--rcfile "file"

Open and parse the given Lua file, in addition to the standard configuration files that are examined.

You may add multiple --rcfile arguments, if you wish to load multiple different files.


Show the version number of your lumail binary, then exit.