Skip to content

Commit

Permalink
fixes #161 - document manual setup of imap/smtp in help/man-page
Browse files Browse the repository at this point in the history
  • Loading branch information
d99kris committed May 19, 2024
1 parent 126120c commit 062ffed
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 6 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,8 +243,9 @@ and fill out the required fields:
drafts=Drafts
imap_host=imap.example.com
imap_port=993
inbox=INBOX
inbox=Inbox
name=Firstname Lastname
sent=Sent
smtp_host=smtp.example.com
smtp_port=587
trash=Trash
Expand Down Expand Up @@ -272,7 +273,7 @@ Full example of a config file `~/.nmail/main.conf`:
idle_timeout=29
imap_host=imap.example.com
imap_port=993
inbox=INBOX
inbox=Inbox
msg_viewer_cmd=
name=Firstname Lastname
network_timeout=30
Expand Down
21 changes: 20 additions & 1 deletion src/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -475,10 +475,29 @@ static void ShowHelp()
"\n"
"Examples:\n"
" nmail -s gmail setup nmail for a gmail account\n"
" nmail running nmail without setup wizard will generate\n"
" default configuration files in ~/.nmail dir if\n"
" not present already, these can be manually edited\n"
" to configure nmail for email service providers not\n"
" supported by the built-in setup wizard (refer to\n"
" FILES section on ~/.nmail/main.conf for details)\n"
"\n"
"Files:\n"
" ~/.nmail/auth.conf configures custom oauth2 client id and secret\n"
" ~/.nmail/main.conf configures mail account and general settings\n"
" ~/.nmail/main.conf configures mail account and general settings, for\n"
" full nmail functionality the following fields\n"
" shall be configured:\n"
" address (ex: [email protected]),\n"
" drafts (folder name, ex: Drafts),\n"
" imap_host (ex: imap.example.com),\n"
" imap_port (ex: 993),\n"
" inbox (folder name, ex: Inbox),\n"
" name (ex: Firstname Lastname),\n"
" sent (folder name, ex: Sent),\n"
" smtp_host (ex: smtp.example.com),\n"
" smtp_port (ex: 465 or 587),\n"
" trash (folder name, ex: Trash),\n"
" user (ex: [email protected] or example).\n"
" ~/.nmail/ui.conf customizes UI settings\n"
" ~/.nmail/secret.conf stores saved passwords\n"
"\n"
Expand Down
25 changes: 23 additions & 2 deletions src/nmail.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
.TH NMAIL "1" "May 2024" "nmail v4.63" "User Commands"
.TH NMAIL "1" "May 2024" "nmail v4.64" "User Commands"
.SH NAME
nmail \- ncurses mail
.SH SYNOPSIS
Expand Down Expand Up @@ -50,7 +50,20 @@ export cache to specified dir in Maildir format
configures custom oauth2 client id and secret
.TP
~/.nmail/main.conf
configures mail account and general settings
configures mail account and general settings, for
full nmail 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).
.TP
~/.nmail/ui.conf
customizes UI settings
Expand All @@ -61,6 +74,14 @@ stores saved passwords
.TP
nmail \-s gmail
setup nmail for a gmail account
.TP
nmail
running nmail without setup wizard will generate
default configuration files in ~/.nmail dir if
not present already, these can be manually edited
to configure nmail for email service providers not
supported by the built\-in setup wizard (refer to
FILES section on ~/.nmail/main.conf for details)
.SH AUTHOR
Written by Kristofer Berggren.
.SH "REPORTING BUGS"
Expand Down
2 changes: 1 addition & 1 deletion src/version.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

#include "version.h"

#define NMAIL_VERSION "4.63"
#define NMAIL_VERSION "4.64"

std::string Version::GetBuildOs()
{
Expand Down

0 comments on commit 062ffed

Please sign in to comment.