You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

315 lines
15 KiB

  1. #!/bin/sh
  2. muttdir="$HOME/.config/mutt" # Main mutt config location
  3. bindir="$HOME/.config/mutt/bin" # Location of scripts run by mutt or the wizard
  4. [ ! -f "$muttdir/domains.csv" ] || [ ! -d "$bindir" ] && printf "Read the README. Be sure to put the repo in the right place before running.\\n" && exit 1
  5. [ ! -f "$HOME/.password-store/.gpg-id" ] && printf "\`pass\` must be installed and initialized to encrypt passwords.\\nBe sure it is installed and run \`pass init <yourgpgemail>\`.\\nIf you don't have a GPG public private key pair, run \`gpg --full-gen-key\` first.\\n" && exit
  6. accdir="$muttdir/accounts" # Directory for account settings
  7. maildir="$HOME/.local/share/mail" # Location of mail storage
  8. namere="^[a-z_][a-z0-9_-]*$" # Regex to ensure viable username
  9. emailre=".\+@.\+\\..\+" # Regex to confirm valid email address
  10. mbsyncrc="$HOME/.mbsyncrc"
  11. sslcert="/etc/ssl/certs/ca-certificates.crt"
  12. getprofiles() { \
  13. unset msmtp_header msmtp_profile mutt_profile mbsync_profile
  14. printf "Creating profiles for \`%s\`..." "$title"
  15. msmtp_header="defaults
  16. auth on
  17. tls on
  18. tls_trust_file $sslcert
  19. logfile ~/.config/msmtp/msmtp.log
  20. "
  21. msmtp_profile="
  22. account $title
  23. host $smtp
  24. port $sport
  25. from $login
  26. user $login
  27. passwordeval \"pass mutt-wizard-$title\""
  28. mbsync_profile="IMAPStore $title-remote
  29. Host $imap
  30. Port $iport
  31. User $login
  32. PassCmd \"pass mutt-wizard-$title\"
  33. SSLType IMAPS
  34. CertificateFile /etc/ssl/certs/ca-certificates.crt
  35. MaildirStore $title-local
  36. Subfolders Verbatim
  37. Path ~/.local/share/mail/$title/
  38. Inbox ~/.local/share/mail/$title/INBOX
  39. Channel $title
  40. Expunge Both
  41. Master :$title-remote:
  42. Slave :$title-local:
  43. Patterns * !\"[Gmail]/All Mail\"
  44. Create Both
  45. SyncState *
  46. # End profile
  47. "
  48. if [ "$accounttype" = "offline" ]; then
  49. mutt_profile="# vim: filetype=neomuttrc
  50. # muttrc file for account $title
  51. set realname = \"$realname\"
  52. set from = \"$fulladdr\"
  53. set sendmail = \"/usr/bin/msmtp -a $title\"
  54. set folder = \"$maildir/$title\"
  55. set header_cache = $accdir/$title/cache/headers
  56. set message_cachedir = $accdir/$title/cache/bodies
  57. set certificate_file = $accdir/$title/certificates
  58. alias me $realname <$fulladdr>
  59. set mbox_type = Maildir
  60. set ssl_starttls = yes
  61. set ssl_force_tls = yes
  62. bind index,pager gg noop
  63. bind index,pager g noop
  64. bind index,pager M noop
  65. bind index,pager C noop
  66. bind index gg first-entry
  67. macro index o \"<shell-escape>$HOME/.config/mutt/bin/mailsync -V $title<enter>\" \"run mbsync to sync $title\"
  68. unmailboxes *
  69. set imap_check_subscribed
  70. "
  71. else
  72. mutt_profile="# vim: filetype=neomuttrc
  73. # muttrc file for account $title
  74. set realname = \"$realname\"
  75. set from = \"$fulladdr\"
  76. set sendmail = \"/usr/bin/msmtp -a $title\"
  77. set folder = \"imaps://$fulladdr@$imap:$iport\"
  78. set imap_user = \"$login\"
  79. set header_cache = $accdir/$title/cache/headers
  80. set message_cachedir = $accdir/$title/cache/bodies
  81. set certificate_file = $accdir/$title/certificates
  82. set imap_pass = \`pass mutt-wizard-$title\`
  83. set smtp_pass = \`pass mutt-wizard-$title\`
  84. alias me $realname <$fulladdr>
  85. set mbox_type = Maildir
  86. set ssl_starttls = yes
  87. set ssl_force_tls = yes
  88. bind index,pager gg noop
  89. bind index,pager g noop
  90. bind index,pager M noop
  91. bind index,pager C noop
  92. bind index gg first-entry
  93. unmailboxes *
  94. "
  95. fi
  96. printf "DONE.\\n"
  97. }
  98. addaccount() { \
  99. printf "Insert the \033[31memail address\033[0m that you want to autoconfigure for mutt/mbsync\\n\tEmail: \033[36m"
  100. read -r fulladdr
  101. printf "\033[0m"
  102. while ! echo "$fulladdr" | grep "$emailre" >/dev/null; do
  103. printf "That is not a valid \033[31memail address\033[0m, please retype the desired email.\\n\\nEmail: \033[36m\t"
  104. read -r fulladdr
  105. printf "\033[0m"
  106. done
  107. domain="$(echo "$fulladdr" | sed "s/.*@//")"
  108. printf "\\nSearching for \033[32m%s\033[0m in \033[34m\`domains.csv\`\033[0m..." "$domain"
  109. serverinfo="$(grep "$domain" "$muttdir/domains.csv" 2>/dev/null)"
  110. if [ -z "$serverinfo" ]; then
  111. 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"
  112. printf "Insert the IMAP server for your email provider (excluding the port number)\\n\033[36m\t"
  113. read -r imap
  114. printf "\033[0mWhat is your server's IMAP port number? (Usually something like 993)\\n\033[36m\t"
  115. read -r iport
  116. printf "\033[0mInsert the SMTP server for your email provider (excluding the port number)\\n\033[36m\t"
  117. read -r smtp
  118. printf "\033[0mWhat is your server's SMTP port number? (Usually 587 or 465)\\n\033[36m\t"
  119. read -r sport
  120. printf "\033[0m\\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"
  121. else
  122. IFS=, read -r service imap iport smtp sport <<EOF
  123. $serverinfo
  124. EOF
  125. 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"
  126. case "$service" in
  127. gmail.com) printf "\033[31mREMEMBER: Gmail users must enable \"less secure\" (third-party) applications first for the sync to work:\\nhttps://support.google.com/accounts/answer/6010255\\n\033[0m" ;;
  128. protonmail.*) printf "\033[31mREMEMBER: Protonmail users must install and configure Protonmail Bridge first for the sync to work:\\nhttps://protonmail.com/bridge/\\n\033[0m" ;;
  129. esac
  130. fi
  131. printf "Enter the \033[35mfull name\033[0m you want to be identified by on this account.\\n\tReal name: "
  132. read -r realname
  133. 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: "
  134. read -r title
  135. while ! echo "$title" | grep "$namere" >/dev/null; do
  136. printf "\033[31mTry again\033[0m. Pick a nickname that is one word only including lowercase letters and _ or -.\\n\tAccount name: \033[36m\t"
  137. read -r title
  138. printf "\033[0m"
  139. done
  140. printf "If your account has a special username different from your address, insert it now. Otherwise leave this prompt totally blank.\\n\tLogin(?): \033[36m\t"
  141. read -r login
  142. printf "\033[0m"
  143. [ -z "$login" ] && login="$fulladdr"
  144. tmpdir="$(mktemp -d)"
  145. grep "i[0-9]" "$muttdir/personal.muttrc" 2>/dev/null | awk '{print $3}' | sed -e 's/i//g' > "$tmpdir/mutt_used"
  146. seq 1 9 > "$tmpdir/mutt_all"
  147. idnum=$(diff "$tmpdir/mutt_all" "$tmpdir/mutt_used" | sed -n 2p | awk '{print $2}')
  148. getpass
  149. getprofiles
  150. mkdir -p "$accdir/$title/cache/bodies" "$HOME/.config/msmtp"
  151. [ ! -f "$HOME/.config/msmtp/config" ] && echo "$msmtp_header" > "$HOME/.config/msmtp/config"
  152. echo "$msmtp_profile" >> "$HOME/.config/msmtp/config"
  153. echo "$mutt_profile" > "$accdir/$title.muttrc"
  154. echo "$mbsync_profile" >> "$mbsyncrc"
  155. echo "macro index,pager i$idnum '<sync-mailbox><enter-command>source $accdir/$title.muttrc<enter><change-folder>!<enter>;<check-stats>' \"switch to $fulladdr\"" >> "$muttdir/personal.muttrc"
  156. ! grep "^source.*.muttrc" "$muttdir/personal.muttrc" >/dev/null && echo "source $accdir/$title.muttrc" >> "$muttdir/personal.muttrc"
  157. trysync && finalize
  158. }
  159. getpass() { pass rm -f "mutt-wizard-$title" >/dev/null 2>&1
  160. while ! pass ls | grep -o " mutt-wizard-$title$" >/dev/null 2>&1;do
  161. pass insert "mutt-wizard-$title"; done;}
  162. formatShortcut() { \
  163. while read -r data; do { echo "macro index,pager g$1 \"<change-folder>$data<enter>\" \"go to $2\" # autogenerated"
  164. echo "macro index,pager M$1 \"<save-message>$data<enter>\" \"move mail to $2\" # autogenerated"
  165. echo "macro index,pager C$1 \"<copy-message>$data<enter>\" \"copy mail to $2\" # autogenerated"; } >> "$accdir/$3.muttrc"
  166. done ;}
  167. trysync() { ! ping -q -c 1 1.1.1.1 > /dev/null && printf "No internet connection detected.\\nTry rerunning \`mbsync %s\` manually when connection is established, then select the option to detect mailboxes and finalize installation.\\n" "$title" && return 1
  168. mkdir -p "$maildir/$title"
  169. if mailboxes="$(mbsync -l "$title")" >/dev/null 2>&1; then
  170. [ "$accounttype" = "online" ] && sed -i "/IMAPStore $title-remote$/,/# End profile/d" "$mbsyncrc"
  171. printf "\033[32mMailboxes detected.\033[0m\\n"
  172. echo "$mailboxes" | xargs -I {} mkdir -p "$maildir/$title/{}"
  173. else
  174. printf "\033[31m\033[31mSync not successful.\033[0m Try running \`mbsync %s\` manually after double-checking your password and server settings.\\nThen select to finalize the account.\\n" "$title"; return 1
  175. fi
  176. }
  177. finalize() { \
  178. boxes="$(du -a "$maildir/$title/"* -d 0 | sed "s/^.*\//=/")"
  179. [ -z "$boxes" ] && printf "\033[31mNo local mailboxes have been detected for %s.\033[0m\\nThis means that mbsync has not been successfully run.\\nRun mbsync, and if it has an error, be sure to check your password and server settings manually if needbe.\\n" "$title" && return
  180. echo "$boxes" > "$tmpdir/title_boxes"
  181. printf "Setting up the mutt sidebar...\\n"
  182. sidebar_width="$(sed -n -e '/^set sidebar_width/p' "$muttdir/muttrc" | awk -F'=' '{print $2}')"
  183. delim="$(head -c "$sidebar_width" < /dev/zero | tr '\0' =)"
  184. printf "Setting default mailboxes for your Inbox, Sent, Drafts and Trash in mutt...\\n"
  185. oneline="$(sed -e "s/^\|$/\"/g" "$tmpdir/title_boxes" | tr "\n" " ")"
  186. oneline="=$title $delim $oneline"
  187. spoolfile=$(grep -i -m 1 "$tmpdir/title_boxes" -e inbox | sed -e 's/=/+/g')
  188. record=$(grep -i -m 1 "$tmpdir/title_boxes" -e sent | sed -e 's/=/+/g')
  189. postponed=$(grep -i -m 1 "$tmpdir/title_boxes" -e draft | sed -e 's/=/+/g')
  190. trash=$(grep -i -m 1 "$tmpdir/title_boxes" -e trash | sed -e 's/=/+/g')
  191. sed -i "/^mailboxes\|^set record\|^set postponed\|^set trash\|^set spoolfile/d" "$accdir/$title.muttrc"
  192. { echo "set spoolfile = \"$spoolfile\""; echo "set record = \"$record\""; echo "set postponed = \"$postponed\""; echo "set trash = \"$trash\""; } >> "$accdir/$title.muttrc"
  193. echo mailboxes "$oneline" >> "$accdir/$title.muttrc"
  194. printf "Setting up your keyboard shortcuts for jumping between mailboxes...\\n"
  195. sed -i "/# autogenerated/d" "$accdir/$title.muttrc"
  196. grep -i -m 1 inbox "$tmpdir/title_boxes" | formatShortcut i inbox "$title"
  197. grep -i -m 1 sent "$tmpdir/title_boxes" | formatShortcut s sent "$title"
  198. grep -i -m 1 draft "$tmpdir/title_boxes" | formatShortcut d drafts "$title"
  199. grep -i -m 1 trash "$tmpdir/title_boxes" | formatShortcut t trash "$title"
  200. grep -i -m 1 spam "$tmpdir/title_boxes" | formatShortcut S spam "$title"
  201. grep -i -m 1 junk "$tmpdir/title_boxes" | formatShortcut j junk "$title"
  202. grep -i -m 1 archive "$tmpdir/title_boxes" | formatShortcut a archive "$title"
  203. [ "$accounttype" = "offline" ] && printf "All done.\\n\033[33mYou should now be able to run \`\033[32mmbsync %s\033[33m\` to begin to download your mail.\033[0m\\n" "$title"
  204. }
  205. confirm() { printf "Are you \033[31;1mreally\033[0m sure you want to %s?\\n\t" "$@" && read -r input && ! echo "$input" | grep -i "y\(es\)*" >/dev/null && printf "That doesn't seem like a yes to me.\\n\\n" && return 1
  206. printf "Are you really, really sure you want to %s?\\n\t" "$@" && read -r input && ! echo "$input" | grep -i "y\(es\)*" >/dev/null && printf "That doesn't seem like a yes to me.\\n\\n" && return 1
  207. return 0 ;}
  208. pick() { numbered="$(find "$accdir" -mindepth 1 -maxdepth 1 -type d -printf "%f\n" | nl)"
  209. [ "$(echo "$numbered" | wc -w)" = 0 ] && printf "No accounts to choose from.\\n" && return 1
  210. printf "Select an accounts to %s:\\n" "$1"
  211. echo "$numbered"
  212. printf "\033[36m\t"
  213. read -r input
  214. printf "\033[0m"
  215. [ -z "$input" ] && return 1
  216. title="$(echo "$numbered" | grep "$input" | awk '{print $2}')"
  217. [ -z "$title" ] && printf "Invalid response." && return 1
  218. return 0 ;}
  219. delete() { sed -i "/IMAPStore $title-remote$/,/# End profile/d" "$mbsyncrc"
  220. rm -rf "${accdir:?}/${title:?}" "$accdir/$title.muttrc"
  221. sed -i "/$title.muttrc/d" "$muttdir/personal.muttrc"
  222. sed -i "/account $title/,/^\(\s*$\|account\)/d" "$HOME/.config/msmtp/config"
  223. }
  224. choosecron() { ! pgrep crond >/dev/null && echo "No cron manager running. Install/enable one and then select this option again." && return 1
  225. if crontab -l | grep mailsync >/dev/null; then
  226. echo "Active mail sync cronjob detected. Do you want to remove it?"
  227. printf "\033[36m\t"
  228. read -r rmyn
  229. printf "\033[0m"
  230. echo "$rmyn" | grep -i "^y\(es\)*$" >/dev/null && crontab -l | sed '/mailsync/d' | crontab - >/dev/null && echo "Mail sync turned off."
  231. else
  232. echo "How many minutes between each mail sync?"
  233. printf "\033[36m\t"
  234. read -r minnum
  235. printf "\033[0m"
  236. while ! echo "$minnum" | grep "^[0-9]\+$" >/dev/null; do
  237. printf "That doesn't look like a number. How many minutes between each mail sync?\\n\033[36m\t"
  238. read -r minnum
  239. printf "\033[0m"
  240. done
  241. (crontab -l; echo "*/$minnum * * * * export DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus; export DISPLAY=:0; . \$HOME/.profile; $muttdir/bin/mailsync") | crontab - &&
  242. echo "Cronjob added. Mail will sync every $minnum minutes. Be sure you have your cron manager running."
  243. fi ;}
  244. addtype() { ! command -v mbsync >/dev/null && printf "You must have the \`mbsync\` command to add an account.\\nIt syncs mail and detects remote mailboxes.\\nYou can typically get it by installing \`isync\`.\\n" && return 1
  245. while : ; do
  246. printf "Do you want to keep your mail for this account offline with mbsync? [yes/no]\\n\t"
  247. read -r offnot
  248. case "$offnot" in
  249. [Yy]es) accounttype="offline" && break ;;
  250. [Nn]o) accounttype="online" && break ;;
  251. *) echo "I don't know what you mean. Try again or press ctrl-c to quit." ;;
  252. esac
  253. done
  254. addaccount ;}
  255. main() { while : ; do
  256. printf "Welcome to:\\n\033[34m"
  257. cat << "EOF"
  258. _ __ ___ _ _| |_| |_ __ _(_)______ _ _ __ __| |
  259. | '_ ` _ \| | | | __| __|___\ \ /\ / / |_ / _` | '__/ _` |
  260. | | | | | | |_| | |_| ||_____\ V V /| |/ / (_| | | | (_| |
  261. |_| |_| |_|\__,_|\__|\__| \_/\_/ |_/___\__,_|_| \__,_|
  262. EOF
  263. printf "\033[0mMade and maintained by Luke Smith <https://lukesmith.xyz>
  264. What would you like \033[32mmutt-wizard\033[0m to do?
  265. 1 Add an email account
  266. 2 Change an account's password
  267. 3 Remove an account
  268. 4 Purge all account data
  269. 5 Enable/disable autosync
  270. 0 Exit
  271. Input a number to continue or press ctrl-c.\\n"
  272. printf "\033[36m\t"
  273. read -r choice
  274. printf "\033[0m"
  275. case "$choice" in
  276. 1) addtype ;;
  277. 2) pick "change the password of" && confirm "change \`$title\`'s password" && getpass ;;
  278. 3) pick delete && confirm "delete the \`$title\` profile" && delete ;;
  279. 4) confirm "delete all account data" && rm -rf "$mbsyncrc" "$accdir" "$muttdir/personal.muttrc" && echo "All configs and account settings have been purged." ;;
  280. 5) choosecron ;;
  281. 0) break ;;
  282. *) printf "Invalid input.\\n"
  283. esac
  284. printf "Press Enter to continue.\\n"
  285. stty -echo
  286. read -r null
  287. stty echo
  288. done ;}
  289. main
  290. rm -rf "$tmpdir"