mutt-wizard/mw

#!/bin/sh

muttdir="$HOME/.config/mutt"		# Main mutt config location
accdir="$muttdir/accounts"		# Directory for account settings
maildir="$HOME/.local/share/mail"	# Location of mail storage
creddir="$HOME/.local/share/muttwizard"	# Location of encrypted credentials
bindir="$HOME/.config/mutt/bin"		# Location of scripts run by mutt or the wizard
namere="^[a-z_][a-z0-9_-]*$"		# Regex to ensure viable username
emailre=".\+@.\+\\..\+" 		# Regex to confirm valid email address
gpgemail="$(cat "$creddir/gpgemail" 2>/dev/null)"	# Get previously set gpg email address
tmpdir="$(mktemp -d)"
GPG="gpg"; command -v gpg >/dev/null || GPG="gpg2"	# Ensure proper gpg command

mkdir -p "$maildir" "$creddir" "$bindir"

# Get certificate location depending on OS. Linux is elsewhere condition.
case "$(uname)" in
	"Darwin") sslcert="/usr/local/etc/openssl/cert.pem" ;;
	*) sslcert="/etc/ssl/certs/ca-certificates.crt" ;;
esac

getprofiles() { \
offlineimap_header="[general]
accounts =
starttls = yes
ssl = true
pythonfile = $bindir/imappwd.py

"
offlineimap_profile="
[Account $title]
localrepository = $title-local
remoterepository = $title-remote

[Repository $title-remote]
auth_mechanisms = LOGIN
type = $type
remoteuser = $login
remotepasseval = mailpasswd(\"$title\")
remoteport = $iport
sslcacertfile = $sslcert
$ifgoogleline

[Repository $title-local]
type = Maildir
localfolders = $maildir/$title
"

msmtp_header="defaults
auth	on
tls	on
tls_trust_file	$sslcert
logfile	~/.config/msmtp/msmtp.log
"

msmtp_profile="

account $title
host $smtp
port $sport
from $login
user $login
passwordeval \"$GPG -d --quiet --for-your-eyes-only --no-tty $creddir/$title.gpg | sed -e '\$a\\'\"
"

mutt_profile="# vim: filetype=neomuttrc
# muttrc file for account $title
set realname = \"$realname\"
set from = \"$fulladdr\"
set sendmail = \"/usr/bin/msmtp -a $title\"
set folder = \"$maildir/$title\"
set header_cache = $accdir/$title/cache/headers
set message_cachedir = $accdir/$title/cache/bodies
set certificate_file = $accdir/$title/certificates
source \"$bindir/getmuttpass $title |\"

alias me $realname <$fulladdr>

set mbox_type = Maildir
set ssl_starttls = yes
set ssl_force_tls = yes

bind index,pager gg noop
bind index,pager g noop
bind index,pager M noop
bind index,pager C noop
bind index gg first-entry
unmailboxes *
"
}

addaccount() { \
	printf "Insert the \033[31memail address\033[0m that you want to autoconfigure for mutt/offlineIMAP\\n\\nEmail: "
	read -r fulladdr
	while ! echo "$fulladdr" | grep "$emailre" >/dev/null; do
		printf "That is not a valid \033[31memail address\033[0m, please retype the desired email.\\n\\nEmail: "
		read -r fulladdr
	done
	domain="$(echo "$fulladdr" | sed "s/.*@//")"
	printf "\\nSearching for \033[32m%s\033[0m in \033[34m\`domains.csv\`\033[0m..." "$domain"
	serverinfo="$(grep "$domain" "$muttdir/domains.csv")"
	if [ -z "$serverinfo" ]; then
		printf "Your email domain is not in mutt-wizard's database yet.\\nmutt-wizard will still autoconfigure everything, but you will have to manually type in your service's IMAP and SMTP server information.\\nYou can usually quickly find this by internet searching for it.\\n"
		printf "Insert the IMAP server for your email provider (excluding the port number)\\n"
		read -r imap
		printf "What is your server's IMAP port number? (Usually something like 993)\\n"
		read -r iport
		printf "Insert the SMTP server for your email provider (excluding the port number)\\n"
		read -r smtp
		printf "What is your server's SMTP port number? (Usually 587 or 465)\\n"
		read -r sport
		printf "\\nGreat! If you want to be helpful, copy the line below and you can add it to the \`domains.csv\` file on Github.\\nThis will make things easier for others who use your email provider.\\n\\n%s,%s,%s,%s,%s\\n\\nAlthough be sure to test to see if these settings work first! ;-)\\n" "$domain" "$imap" "$iport" "$smtp" "$sport"
	else
		IFS=, read service imap iport smtp sport <<EOF
$serverinfo
EOF
	printf "\\n\033[3;33mCongrats!\033[0m Server info has automatically be found, so you won't have to look anything up!\\n\t\033[1mIMAP server\033[0m: %s\\n\t\033[1mIMAP port\033[0m: %s\\n\t\033[1mSMTP server\033[0m: %s\\n\t\033[1mSMTP port\033[0m: %s\\nThis data will be used by the wizard.\\n" "$imap" "$iport" "$smtp" "$sport"
	fi
	printf "\\nPress enter to continue.\\n"
	stty -echo
	read wait
	stty echo
	printf "Enter the \033[35mfull name\033[0m you want to be identified by on this account.\\n\tReal name: "
	read -r realname
	printf "Enter a short, \033[36mone-word identifier\033[0m for this email account that will distinguish them from any other accounts you add.\\n\tAccount name: "
	read -r title
	while ! echo "$title" | grep "$namere" >/dev/null; do
		printf "\033[31mTry again\033[0m. Pick a nickname that is one word only including lowercase letters and _ or -.\\n\tAccount name: "
		read -r title
	done
	printf "If your account has a special username different from your address, insert it now. Otherwise leave this prompt totally blank.\\n\tLogin(?): "
	read -r login
	[ -z "$login" ] && login="$fulladdr"
	if [ "$service" = "gmail.com" ]; then
		type="Gmail"; ifgoogleline="folderfilter = lambda foldername: foldername not in ['[Gmail]/All Mail']"
		printf "\033[1mGoogle\033[0m mail account detected. Remember to check the README to make sure of Google-specific settings you must enable.\\n"
	else
		type="IMAP"; ifgoogleline="remotehost = $imap"
	fi
	grep "i[0-9]" "$muttdir/personal.muttrc" | awk '{print $3}' | sed -e 's/i//g' > "$tmpdir/mutt_used"
	seq 1 9 > "$tmpdir/mutt_all"
	idnum=$(diff "$tmpdir/mutt_all" "$tmpdir/mutt_used" | sed -n 2p | awk '{print $2}')
	getpass "$title"
	getprofiles
	mkdir -p "$HOME/.config/offlineimap/" "$HOME/.config/msmtp"
	[ ! -f "$HOME/.config/offlineimap/config" ] && echo "$offlineimap_header" > "$HOME/.config/offlineimap/config"
	[ ! -f "$HOME/.config/msmtp/config" ] && echo "$msmtp_header" > "$HOME/.config/msmtp/config"
	echo "$offlineimap_profile" >> "$HOME/.config/offlineimap/config"
	echo "$msmtp_profile" >> "$HOME/.config/msmtp/config"
	echo "$mutt_profile" > "$accdir/$title.muttrc"
	trysync && finalize
}

getpass() { \
	printf "Now enter your password for the \"%s\" account. Don't worry, this will be encrypted and only you with your GPG key can view it.\\n\tPassword: " "$1"
	stty -echo
	read -r password
	stty echo
	echo "$password" > "$tmpdir/$1"
	printf "Encrypting your password with %s..."
	"$GPG" -r "$gpgemail" --encrypt "$tmpdir/$1"
	print "DONE\\nShredding all memory of your password for safety's sake..."
	unset password
	shred -u "$tmpdir/$1" | rm -f "$tmpdir/$1"
	mv "$tmpdir/$1.gpg" "$creddir"
	printf "DONE.\\n"
}

askgpg() { \
	printf "To safely encrypt passwords, mutt-wizard requires that you have a GPG public/private key pair.\\n\\nPlease input the email address of your GPG key pair below.\\nEmail: "
	read -r gpgemail
	while ! echo "$gpgemail" | grep "$emailre" >/dev/null; do
		printf "That is not a valid email address. Please try again.\\nEmail: "
		read -r gpgemail
	done
	if "$GPG" -K | grep "<$gpgemail>" >/dev/null; then
		echo "$gpgemail" > "$creddir/gpgemail"
	else
		printf "You do not appear to have a private key associated with %s.\\nPlease generate a GPG key pair by running \`%s --full-gen-key\` and rerun the wizard.\\n" "$gpgemail" "$GPG"
		exit 1
	fi
}

formatShortcut() { \
	while read data; do { echo "macro index,pager g$1 \"<change-folder>$data<enter>\" \"Go to $2.\" # autogenerated"
	echo "macro index,pager M$1 \"<save-message>$data<enter>\" \"Move mail to $2.\" # autogenerated"
	echo "macro index,pager C$1 \"<copy-message>$data<enter>\" \"Copy mail to $2.\" # autogenerated"; } >> "$muttdir/accounts/$3.muttrc"
	done ;}

gen_delim() { \
	delim="="
	for i in $(seq $(( $1 - 1 )))
	do
		delim="$delim-"
	done
	echo $delim ;}

trysync() { \
	! ping -q -c 1 1.1.1.1 > /dev/null && printf "No internet connection detected.\\nTry rerunning offlineimap manually when connection is established, then select the option to detect mailboxes and finalize installation.\\n" && exit 1
	printf "mutt-wizard will run offlineimap briefly to (1) ensure that login details are functional and (2) allow offlineimap to tell us what mailboxes your email account has.\\nAfter around 15 seconds, mutt-wizard will kill the process and continue.\\nYou can run offlineimap manually to finish the mail sync later.\\nPress enter to continue.\\n."
	stty -echo
	read wait
	stty echo
	(sleep 15; killall offlineimap; killall offlineimap; killall offlineimap) &
	offlineimap -qoa "$title"
	if ls -d "$maildir/$1/"* >/dev/null 2>&1; then
		printf "\033[32mSync successful.\033[0m\\n"; exit
	else
		printf "\033[31m\033[31mSync not successful.\033[0m Try running offlineimap manually after double-checking your password and server settings.\\nThen select to finalize the account.\\n"; exit 1
	fi
}

finalize() { \
	boxes="$(ls -d "$maildir/$title/"* 2>/dev/null | sed "s/.*\///;s/^/=/")"
	[ -z "$boxes" ] && printf "\033[31mNo local mailboxes have been detected for %s.\033[0m\\nThis means that offlineimap has not been successfully run.\\nRun offlineimap, and if it has an error, be sure to check your password and server settings manually if needbe.\\n" "$title" && exit
	echo "$boxes" > "$tmpdir/$title_boxes"
	printf "Setting up the mutt sidebar...\\n"
	sidebar_width="$(sed -n -e '/^set sidebar_width/p' "$muttdir/muttrc" | awk -F'=' '{print $2}')"
	delim="$(gen_delim "$sidebar_width")"
	printf "Setting default mailboxes for your Inbox, Sent, Drafts and Trash in mutt...\\n"
	oneline="$(sed -e "s/^\|$/\"/g" "$tmpdir/$title_boxes" | tr "\n" " ")"
	oneline="=$title $delim $oneline"
	spoolfile=$(grep -i "$tmpdir/$title_boxes" -e inbox | sed -e 's/=/+/g' | sed 1q)
	record=$(grep -i "$tmpdir/$title_boxes" -e sent | sed -e 's/=/+/g' | sed 1q)
	postponed=$(grep -i "$tmpdir/$title_boxes" -e draft | sed -e 's/=/+/g' | sed 1q)
	trash=$(grep -i "$tmpdir/$title_boxes" -e trash | sed -e 's/=/+/g' | sed 1q)
	{ echo "set spoolfile = \"$spoolfile\""; echo "set record = \"$record\""; echo "set postponed = \"$postponed\""; echo "set trash = \"$trash\""; } >> "$muttdir/accounts/$title.muttrc"
	sed -i "/^mailboxes\|^set record\|^set postponed\|^set trash\|^set spoolfile/d" "$muttdir/accounts/$title.muttrc"
	echo mailboxes "$oneline" >> "$muttdir/accounts/$title.muttrc"
	printf "Setting up your keyboard shortcuts for jumping between mailboxes...\\n"
	sed -i "/# autogenerated/d" "$muttdir/accounts/$title.muttrc"
	grep -i "$tmpdir/$title_boxes" -e inbox | sed 1q | formatShortcut i inbox "$title"
	grep -i "$tmpdir/$title_boxes" -e sent | sed 1q | formatShortcut s sent "$title"
	grep -i "$tmpdir/$title_boxes" -e draft | sed 1q | formatShortcut d drafts "$title"
	grep -i "$tmpdir/$title_boxes" -e trash | sed 1q | formatShortcut t trash "$title"
	grep -i "$tmpdir/$title_boxes" -e spam | sed 1q | formatShortcut S spam "$title"
	grep -i "$tmpdir/$title_boxes" -e junk | sed 1q | formatShortcut j junk "$title"
	grep -i "$tmpdir/$title_boxes" -e archive | sed 1q | formatShortcut a archive "$title"
	printf "All done.\\n"
}

#wipe () { rm "$HOME/.config/offlineimap/config" "$accdir" "$creddir" "$muttdir/personal.muttrc" ;}

[ -z "$gpgemail" ] && askgpg

pick() { \
	grep "^accounts *=" "$HOME/.config/offlineimap/config" | sed 's/accounts *= *//g;s/,/ /g;s/ \+/\n/g' | nl > "$tmpdir/numbered"
	cat "$tmpdir/numbered"
	print "Select (an) account(s) to %s.\\n" "$1"
	read -r input
	title="$(cat "$tmpdir/numbered" | grep "$input" | awk '{print $2}')"
	[ -z "$title" ] && printf "Invalid response." && exit 1
	[ ! -z "$2" ] && printf "Are you sure you want to %s the \`%s\` account?" "$1" "$title" && read -r input && echo "$input" | grep -i "y\(es\)*" >/dev/null
}

removeAccount() { sed -ie "
	/Account $1]/,/Account/{//!d}
	/Account $1]/d
	s/ $1\(,\|$\)//g
	s/=$1\(,\|$\)/=/g
	s/,$//g
	" "$HOME/.config/offlineimap/config"
	rm "$muttdir/accounts/$1.muttrc"
	rm "$muttdir/credentials/$1.gpg"
	rm -rf "$muttdir/accounts/$1"
	sed -i "/$1.muttrc/d" "$muttdir/personal.muttrc"
	# Delete from the line matching the account name, until the next account or empty line
	sed -i "/account $1/,/^\(\s*$\|account\)/d" "$HOME/.config/msmtp/config";}

main() { \
	while : ; do
	printf "What would you like \033[32mmutt-wizard\033[0m to do?
	\033[31m1 Add an email account\033[0m
	2 Autodetect mailboxes
	3 Change an account's password
	4 Change GPG key pair used for encryption
	0 Exit
Input a number to continue or press ctrl-c.\\n"
	read -r choice
	case "$choice" in
		1) addaccount ;;
		2) pick delete yes && finalize "$title" ;;
		4) askgpg ;;
		0) break ;;
		*) printf "Invalid input.\\n"
	esac
done
}

main

rm -rf "$tmpdir"