Lumail - The console email client


Lua primitives: maildir_format()

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

A simple format-string is used to control how maildir-lists are displayed in maildir-mode. The format string is fetched/updated via the maildir_format() function.

The value can be set or retrieved like so:

-- Set the string
maildir_format( "$CHECK - $PATH" );

-- Get the setting, and display it
msg( maildir_format() );

The format string clearly makes use of variables like "$CHECK" to display particular pieces of information about the maildir-folder. The following table lists possible values:

$CHECK"[X]" if the folder is selected, "[ ]" otherwise.
$TOTALThe total number of messages in the maildir.
$NEWThe total number of new/unread messages in the maildir.
$UNREADThe total number of new/unread messages in the maildir.
$READThe total number of old/read messages in the maildir.
$PATHThe full path to the maildir.
$NAMEThe last component of the maildir-name.

Availability

This function has been available since version 0.07.

See Also

See also get_variables, index_format.