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