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.

mw 16 KiB

5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
  1. #!/bin/sh
  2. command -V gpg >/dev/null 2>&1 && GPG="gpg" || GPG="gpg2"
  3. [ -r "$HOME/.password-store/.gpg-id" ] &&
  4. "$GPG" --list-secret-keys $(cat "$HOME/.password-store/.gpg-id") >/dev/null 2>&1 || {
  5. 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"
  6. exit
  7. }
  8. ! command -v mbsync >/dev/null && printf "\`mbsync\` must be installed to run mutt-wizard.\\n" && exit
  9. case "$(uname)" in
  10. Linux) prefix="/usr" ;;
  11. *) prefix="/usr/local" ;;
  12. esac
  13. muttdir="$HOME/.config/mutt" # Main mutt config location
  14. accdir="$muttdir/accounts" # Directory for account settings
  15. maildir="$HOME/.local/share/mail" # Location of mail storage
  16. namere="^[a-z_][a-z0-9_-]*$" # Regex to ensure viable username
  17. emailre=".\+@.\+\\..\+" # Regex to confirm valid email address
  18. muttshare="$prefix/share/mutt-wizard"
  19. mbsyncrc="$HOME/.mbsyncrc"
  20. mwconfig="$muttshare/mutt-wizard.muttrc"
  21. cachedir="$HOME/.cache/mutt-wizard"
  22. muttrc="$muttdir/muttrc"
  23. msmtprc="$HOME/.config/msmtp/config"
  24. ssltype="IMAPS" # This is later changed to `None` later in the script if using Protonmail
  25. for x in "/etc/ssl/certs/ca-certificates.crt" "/etc/pki/tls/certs/ca-bundle.crt" "/etc/ssl/ca-bundle.pem" "/etc/pki/tls/cacert.pem" "/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem" "/etc/ssl/cert.pem"
  26. do
  27. [ -f "$x" ] && sslcert="$x" && break
  28. done || { echo "CA Certificate not found. Please install one or link it to /etc/ssl/certs/ca-certificates.crt" && exit 1 ;}
  29. getaccounts() { accounts="$(find "$accdir" -type f | grep -o "[0-9]-.*.muttrc" | sed "s/-/: /;s/\..*//" | sort -n)" ;}
  30. list() { getaccounts && [ -n "$accounts" ] && echo "$accounts" ;}
  31. getprofiles() { \
  32. unset msmtp_header msmtp_profile mutt_profile mbsync_profile
  33. printf "Creating profiles for \`%s\`..." "$title"
  34. msmtp_header="defaults
  35. auth on
  36. tls on
  37. tls_trust_file $sslcert
  38. logfile ~/.config/msmtp/msmtp.log
  39. "
  40. msmtp_profile="account $title
  41. host $smtp
  42. port $sport
  43. from $fulladdr
  44. user $login
  45. passwordeval \"pass mutt-wizard-$title\"
  46. "
  47. mbsync_profile="IMAPStore $title-remote
  48. Host $imap
  49. Port $iport
  50. User $login
  51. PassCmd \"pass mutt-wizard-$title\"
  52. SSLType $ssltype
  53. CertificateFile $sslcert
  54. MaildirStore $title-local
  55. Subfolders Verbatim
  56. Path ~/.local/share/mail/$title/
  57. Inbox ~/.local/share/mail/$title/INBOX
  58. Flatten .
  59. Channel $title
  60. Expunge Both
  61. Master :$title-remote:
  62. Slave :$title-local:
  63. Patterns * !\"[Gmail]/All Mail\"
  64. Create Both
  65. SyncState *
  66. MaxMessages $maxmes
  67. # End profile
  68. "
  69. if [ "$accounttype" = "offline" ]; then
  70. mutt_profile="# vim: filetype=neomuttrc
  71. # muttrc file for account $title
  72. set realname = \"$realname\"
  73. set from = \"$fulladdr\"
  74. set sendmail = \"msmtp -a $title\"
  75. alias me $realname <$fulladdr>
  76. set folder = \"$maildir/$title\"
  77. set header_cache = $cachedir/$title/headers
  78. set message_cachedir = $cachedir/$title/bodies
  79. set mbox_type = Maildir
  80. bind index,pager gg noop
  81. bind index,pager g noop
  82. bind index,pager M noop
  83. bind index,pager C noop
  84. bind index gg first-entry
  85. macro index o \"<shell-escape>mailsync -V $title<enter>\" \"run mbsync to sync $title\"
  86. unmailboxes *
  87. "
  88. else
  89. mutt_profile="# vim: filetype=neomuttrc
  90. # muttrc file for account $title
  91. set realname = \"$realname\"
  92. set from = \"$fulladdr\"
  93. set sendmail = \"$prefix/bin/msmtp -a $title\"
  94. alias me $realname <$fulladdr>
  95. set folder = \"imaps://$fulladdr@$imap:$iport\"
  96. set imap_user = \"$login\"
  97. set header_cache = $cachedir/$title/headers
  98. set message_cachedir = $cachedir/$title/bodies
  99. set imap_pass = \`pass mutt-wizard-$title\`
  100. set mbox_type = Maildir
  101. set ssl_starttls = yes
  102. set ssl_force_tls = yes
  103. bind index,pager gg noop
  104. bind index,pager g noop
  105. bind index,pager M noop
  106. bind index,pager C noop
  107. bind index gg first-entry
  108. unmailboxes *
  109. "
  110. fi
  111. printf "DONE.\\n"
  112. }
  113. askinfo() { \
  114. printf "Insert the \033[31memail address\033[0m that you want to autoconfigure for mutt/mbsync\\n\tEmail: \033[36m"
  115. read -r fulladdr
  116. printf "\033[0m"
  117. while ! echo "$fulladdr" | grep "$emailre" >/dev/null; do
  118. printf "That is not a valid \033[31memail address\033[0m, please retype the desired email.\\n\\nEmail: \033[36m\t"
  119. read -r fulladdr
  120. printf "\033[0m"
  121. done
  122. domain="$(echo "$fulladdr" | sed "s/.*@//")"
  123. printf "\\nSearching for \033[32m%s\033[0m in \033[34m\`domains.csv\`\033[0m..." "$domain"
  124. serverinfo="$(grep "^$domain" "$muttshare/domains.csv" 2>/dev/null)"
  125. if [ -z "$serverinfo" ]; then
  126. 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"
  127. printf "Insert the IMAP server for your email provider (excluding the port number)\\n\033[36m\t"
  128. read -r imap
  129. printf "\033[0mWhat is your server's IMAP port number? (Usually something like 993)\\n\033[36m\t"
  130. read -r iport
  131. printf "\033[0mInsert the SMTP server for your email provider (excluding the port number)\\n\033[36m\t"
  132. read -r smtp
  133. printf "\033[0mWhat is your server's SMTP port number? (Usually 587 or 465)\\n\033[36m\t"
  134. read -r sport
  135. 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"
  136. else
  137. IFS=, read -r service imap iport smtp sport <<EOF
  138. $serverinfo
  139. EOF
  140. printf "\\n\033[3;33mCongrats!\033[0m Server info has automatically been 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"
  141. case "$service" in
  142. 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" ;;
  143. protonmail.ch|protonmail.com|pm.me) printf "\033[31mREMEMBER: Protonmail users must install and configure Protonmail Bridge first for the sync to work:\\nhttps://protonmail.com/bridge/\\n\033[0m" && ssltype="None" ;;
  144. esac
  145. fi
  146. printf "Enter the \033[35mfull name\033[0m you want to be identified by on this account.\\n\tReal name: "
  147. read -r realname
  148. 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: "
  149. read -r title
  150. while ! echo "$title" | grep "$namere" >/dev/null || ls "$accdir"/[0-9]"-$title.muttrc" >/dev/null 2>&1; do
  151. printf "\033[31mTry again\033[0m. Pick a nickname that is one word only including lowercase letters and _ or - and that you have \033[1mnot\033[0m used before.\\n\tAccount name: \033[36m\t"
  152. read -r title
  153. printf "\033[0m"
  154. done
  155. printf "If your account has a special username different from your address, insert it now. Otherwise leave this prompt totally blank.\\n\033[34mMost accounts will not have a separate login, so you should probably leave this blank.\033[0m\\n\tLogin(?): \033[36m"
  156. read -r login
  157. printf "\033[0m"
  158. [ -z "$login" ] && login="$fulladdr"
  159. [ "$accounttype" = "offline" ] && printf "If you want to limit the number of messages kept offline to a number, enter that number below. If you do not want to limit your mail and would like \`mbsync\` to sync all mail, press enter without typing a number.\\n\t" && read -r maxmes
  160. echo "$maxmes" | grep "[1-9]" >/dev/null || maxmes="0"
  161. getpass
  162. getprofiles
  163. mkdir -p "$muttdir" "$accdir" "$cachedir/$title/bodies" "$HOME/.config/msmtp"
  164. getaccounts
  165. for x in $(seq 1 9); do echo "$accounts" | grep "$x" >/dev/null 2>&1 || { export idnum="$x"; break ;}; done
  166. [ ! -f "$msmtprc" ] && echo "$msmtp_header" > "$msmtprc"
  167. echo "$msmtp_profile" >> "$msmtprc"
  168. command -V apt-get >/dev/null 2>&1 && ln -s "$msmtprc" "$HOME/.msmtprc" 2>/dev/null
  169. case "$service" in
  170. protonmail.ch|protonmail.com|pm.me) protonfinger || return 1 ;;
  171. esac
  172. echo "$mutt_profile" > "$accdir/$idnum-$title.muttrc"
  173. echo "$mbsync_profile" >> "$mbsyncrc"
  174. notmuchauto
  175. [ ! -f "$muttrc" ] && echo "# vim: filetype=neomuttrc" > "$muttrc" && echo "muttrc created."
  176. ! grep "^source.*mutt-wizard.muttrc" "$muttrc" >/dev/null && echo "source $mwconfig # mw-autogenerated" >> "$muttrc"
  177. ! grep "^source.*.muttrc" "$muttrc" | grep -v "$mwconfig" >/dev/null && echo "source $accdir/$idnum-$title.muttrc # mw-autogenerated" >> "$muttrc"
  178. echo "macro index,pager i$idnum '<sync-mailbox><enter-command>source $accdir/$idnum-$title.muttrc<enter><change-folder>!<enter>;<check-stats>' \"switch to $fulladdr\" # mw-autogenerated" >> "$muttrc"
  179. }
  180. protonfinger() { printf "Getting Protonmail bridge fingerprint...\\n"
  181. fingerprint="$(msmtp --serverinfo --tls --tls-certcheck=off -a "$title")" || return 1
  182. sed -ibu "s/account $title/&\ntls_trust_file\ntls_fingerprint $fingerprint/" "$msmtprc" ; rm -f "$msmtprc"bu
  183. }
  184. getpass() { while : ; do pass rm -f "mutt-wizard-$title" >/dev/null 2>&1
  185. pass insert "mutt-wizard-$title" && break; done ;}
  186. formatShortcut() { \
  187. while read -r data; do { echo "macro index,pager g$1 \"<change-folder>$data<enter>\" \"go to $2\" # mw-autogenerated"
  188. echo "macro index,pager M$1 \"<save-message>$data<enter>\" \"move mail to $2\" # mw-autogenerated"
  189. echo "macro index,pager C$1 \"<copy-message>$data<enter>\" \"copy mail to $2\" # mw-autogenerated"; } >> "$accdir/$idnum-$title.muttrc"
  190. done ;}
  191. tryconnect() { mkdir -p "$maildir/$title"
  192. if mailboxes="$(mbsync -l "$title" | sed 's/\//./')" >/dev/null 2>&1 && [ -n "$mailboxes" ]; then
  193. [ "$accounttype" = "online" ] && sed -ibu "/IMAPStore $title-remote$/,/# End profile/d" "$mbsyncrc" ; rm -f "$mbsyncrc"bu
  194. printf "\033[32mMailboxes detected.\033[0m\\n"
  195. echo "$mailboxes" | xargs -I {} mkdir -p "$maildir/$title/{}"
  196. return 0
  197. else
  198. printf "\033[31m\033[31mLog-on not successful.\033[0m\\nIt seems that either you inputted the wrong password or server settings, or there are other requirements for your account out of the control of mutt-wizard.\\n"
  199. return 1
  200. fi ;}
  201. finalize() { \
  202. boxes="$(find "$maildir/$title/" -mindepth 1 -maxdepth 1 | sed "s/\ /\\\ /g;s/^.*\//=/")"
  203. [ -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
  204. printf "Setting default mailboxes for your Inbox, Sent, Drafts and Trash in mutt...\\n"
  205. spoolfile=$(echo "$boxes" | grep -i -m 1 inbox | sed 's/=/+/g')
  206. record=$(echo "$boxes" | grep -i -m 1 sent | sed 's/=/+/g')
  207. postponed=$(echo "$boxes" | grep -i -m 1 draft | sed 's/=/+/g')
  208. trash=$(echo "$boxes" | grep -i -m 1 trash | sed 's/=/+/g')
  209. sed -ibu "/^mailboxes\|^set record\|^set postponed\|^set trash\|^set spoolfile/d" "$accdir/$idnum-$title.muttrc" ; rm -f "$accdir/$idnum-$title.muttrcbu"
  210. { echo "set spoolfile = \"$spoolfile\""; echo "set record = \"$record\""; echo "set postponed = \"$postponed\""; echo "set trash = \"$trash\""; } >> "$accdir/$idnum-$title.muttrc"
  211. echo "mailboxes =$title ===================== $(echo "$boxes" | sed -e "s/^\|$/\"/g" | tr "\n" " ")" >> "$accdir/$idnum-$title.muttrc"
  212. printf "Setting up your keyboard shortcuts for jumping between mailboxes...\\n"
  213. sed -ibu "/# mw-autogenerated/d" "$accdir/$idnum-$title.muttrc" ; rm -f "$accdir/$idnum-$title.muttrcbu"
  214. echo "$boxes" | grep -i inbox | head -n 1 | formatShortcut i inbox
  215. echo "$boxes" | grep -i sent | head -n 1 | formatShortcut s sent
  216. echo "$boxes" | grep -i draft | head -n 1 | formatShortcut d drafts
  217. echo "$boxes" | grep -i trash | head -n 1 | formatShortcut t trash
  218. echo "$boxes" | grep -i spam | head -n 1 | formatShortcut S spam
  219. echo "$boxes" | grep -i junk | head -n 1 | formatShortcut j junk
  220. echo "$boxes" | grep -i archive | head -n 1 | formatShortcut a archive
  221. [ "$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"
  222. command -V urlview >/dev/null 2>&1 && [ ! -f "$HOME/.urlview" ] && echo "COMMAND \$BROWSER" > "$HOME/.urlview"
  223. return 0
  224. }
  225. confirm() { printf "Do you want to %s? [y/N]\\n\t" "$@" && read -r input && ! echo "$input" | grep -i "^y$\|^yes$" >/dev/null && printf "That doesn't seem like a yes to me.\\n\\n" && return 1
  226. printf "Are you really, really sure you want to %s?\\n\t" "$@" && read -r input && ! echo "$input" | grep -i "^y$\|^yes$" >/dev/null && printf "That doesn't seem like a yes to me.\\n\\n" && return 1
  227. return 0 ;}
  228. pick() { printf "Select an accounts to %s:\\n" "$1"
  229. list
  230. read -r input
  231. [ -z "$input" ] && return 1
  232. title="$(echo "$accounts" | grep "$input" | awk '{print $2}')"
  233. [ -z "$title" ] && printf "Invalid response." && return 1
  234. return 0 ;}
  235. delete() { sed -ibu "/IMAPStore $title-remote$/,/# End profile/d" "$mbsyncrc" ; rm -rf "$mbsyncrc"bu
  236. rm -rf "${cachedir:?}/${title:?}" "$accdir/"[1-9]"-$title.muttrc"
  237. sed -ibu "/[0-9]-$title.muttrc/d" "$muttrc" ; rm -f "$muttrc"bu
  238. sed -ibu "/account $title/,/^\(\s*$\|account\)/d" "$msmtprc"; rm -f "$msmtprc"bu
  239. }
  240. choosecron() { ! pgrep cron >/dev/null && echo "No cron manager running. Install/enable one and then select this option again." && return 1
  241. if crontab -l | grep mailsync >/dev/null; then
  242. echo "Active mail sync cronjob detected. Do you want to remove it?"
  243. printf "\033[36m\t"
  244. read -r rmyn
  245. printf "\033[0m"
  246. echo "$rmyn" | grep -i "^y\(es\)*$" >/dev/null && crontab -l | sed '/mailsync/d' | crontab - >/dev/null && echo "Mail sync turned off."
  247. else
  248. echo "How many minutes between each mail sync?"
  249. printf "\033[36m\t"
  250. read -r minnum
  251. printf "\033[0m"
  252. while ! echo "$minnum" | grep "^[0-9]\+$" >/dev/null; do
  253. printf "That doesn't look like a number. How many minutes between each mail sync?\\n\033[36m\t"
  254. read -r minnum
  255. printf "\033[0m"
  256. done
  257. (crontab -l; echo "*/$minnum * * * * export DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/$(id -u)/bus; export DISPLAY=:0; . \$HOME/.profile; $(type mailsync | cut -d' ' -f3)") | crontab - &&
  258. echo "Cronjob added. Mail will sync every $minnum minutes. Be sure you have your cron manager running."
  259. fi ;}
  260. asktype() { while : ; do
  261. printf "Do you want to keep your mail for this account offline with mbsync? [yes/no]\\n\t"
  262. read -r offnot
  263. case "$offnot" in
  264. [Yy][Ee][Ss]) accounttype="offline" && break ;;
  265. [Nn][Oo]) accounttype="online" && break ;;
  266. *) echo "Write out either yes or no completely. Try again or press ctrl-c to quit." ;;
  267. esac; done ;}
  268. purge() { confirm "delete all account data" || exit
  269. rm -rf "$mbsyncrc" "$accdir" "$HOME/.config/msmtp" "$cachedir"
  270. echo "All configs and account settings have been purged."
  271. sed -ibu "/\# mw-autogenerated/d" "$muttrc" ; rm -f "$muttrc"bu
  272. }
  273. notmuchauto() { \
  274. [ -z "$NOTMUCH_CONFIG" ] && NOTMUCH_CONFIG="$HOME/.notmuch-config"
  275. [ -f "$NOTMUCH_CONFIG" ] && return 0
  276. nmbasic="[database]
  277. path=$maildir
  278. [user]
  279. name=$realname
  280. primary_email=$fulladdr
  281. [new]
  282. tags=unread;inbox;
  283. ignore=
  284. [search]
  285. exclude_tags=deleted;spam;
  286. [maildir]
  287. synchronize_flags=true
  288. [crypto]
  289. gpg_path=$GPG"
  290. echo "$nmbasic" > "$NOTMUCH_CONFIG" ;}
  291. case "$1" in
  292. ls) list ;;
  293. add) asktype && askinfo && tryconnect && finalize || delete ;;
  294. pass) pick "change the password of" && getpass ;;
  295. delete) pick delete && confirm "delete the \`$title\` profile" && delete ;;
  296. purge) purge ;;
  297. cron) choosecron ;;
  298. *) cat << EOF
  299. mw: mutt-wizard, auto-configure email accounts for mutt
  300. including downloadable mail with \`isync\`.
  301. Allowed options:
  302. add Add and autoconfigure an email address (9 max.)
  303. ls List configured accounts
  304. delete Pick an account to delete
  305. purge Delete all accounts and settings
  306. cron Enable or disable an autosync via cronjob
  307. all else Print this message
  308. NOTE: Once at least one account is added, you can run
  309. \`mbsync -a\` to begin downloading mail.
  310. EOF
  311. esac