nmail - ncurses mail

NAME SYNOPSIS DESCRIPTION OPTIONS FILES EXAMPLES AUTHOR REPORTING BUGS COPYRIGHT

DESCRIPTION

nmail is a terminal−based email client with a user interface similar to alpine / pine, supporting IMAP and SMTP.

OPTIONS

−c, −−cache−encrypt

prompt for cache encryption during oauth2 setup

−d, −−confdir <DIR>

use a different directory than ˜/.config/nmail

−e, −−verbose

enable verbose logging

−ee, −−extra−verbose

enable extra verbose logging

−h, −−help

display this help and exit

−k, −−keydump

key code dump mode

−o, −−offline

run in offline mode

−p, −−pass

change password

−ro, −−read−only

run shadow instance with read−only cache access

−s, −−setup <SERVICE>

setup wizard for specified service, supported services: gmail, gmail−oauth2, icloud, outlook, outlook−oauth2

−v, −−version

output version information and exit

−x, −−export <DIR>

export cache to specified dir in Maildir format

FILES

˜/.config/nmail/auth.conf

configures custom oauth2 client id and secret

˜/.config/nmail/key.conf

configures user interface key bindings

˜/.config/nmail/main.conf

configures mail account and general settings, for full functionality the following fields shall be configured: address (ex: [email protected]), drafts (folder name, ex: Drafts), imap_host (ex: imap.example.com), imap_port (ex: 993), inbox (folder name, ex: Inbox), name (ex: Firstname Lastname), sent (folder name, ex: Sent), smtp_host (ex: smtp.example.com), smtp_port (ex: 465 or 587), trash (folder name, ex: Trash), user (ex: [email protected] or example).

˜/.config/nmail/ui.conf

customizes user interface settings

EXAMPLES

nmail −s gmail

setup nmail for a gmail account

nmail

running nmail without setup wizard will generate default configuration files in the nmail dir if not present already, these can be edited to configure nmail for email service providers not supported by the built−in setup wizard (refer to FILES section for details)