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