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 13 KiB

4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
4 years ago
5 years ago
5 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
4 years ago
4 years ago
4 years ago
5 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  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 \`%s --full-gen-key\` first.\\n" "$GPG"
  7. exit
  8. }
  9. prefix="/usr/local"
  10. pass_prefix="mw-"
  11. muttdir="${XDG_CONFIG_HOME:-$HOME/.config}/mutt" # Main mutt config location
  12. accdir="$muttdir/accounts" # Directory for account settings
  13. maildir="${XDG_DATA_HOME:-$HOME/.local/share}/mail" # Location of mail storage
  14. namere="^[a-z_][a-z0-9_-]*$" # Regex to ensure viable username
  15. emailre=".+@.+\..+" # Regex to confirm valid email address
  16. muttshare="$prefix/share/mutt-wizard"
  17. mbsyncrc="${MBSYNCRC:-$HOME/.mbsyncrc}"
  18. mwconfig="$muttshare/mutt-wizard.muttrc"
  19. cachedir="${XDG_CACHE_HOME:-$HOME/.cache}/mutt-wizard"
  20. muttrc="$muttdir/muttrc"
  21. msmtprc="${XDG_CONFIG_HOME:-$HOME/.config}/msmtp/config"
  22. msmtplog="${XDG_CONFIG_HOME:-$HOME/.config}/msmtp/msmtp.log"
  23. MARKER="# mw-autogenerated"
  24. alias mbsync='mbsync -c "$mbsyncrc"'
  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" "/usr/local/share/ca-certificates/"
  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/\.muttrc$//" | sort -n)" ;}
  30. list() { getaccounts && [ -n "$accounts" ] && echo "$accounts" ;}
  31. getprofiles() { \
  32. unset msmtp_header msmtp_profile mutt_profile mbsync_profile
  33. msmtp_header="defaults
  34. auth on
  35. tls on
  36. tls_trust_file $sslcert
  37. logfile $msmtplog
  38. "
  39. msmtp_profile="account $fulladdr
  40. host $smtp
  41. port ${sport:-587}
  42. from $fulladdr
  43. user $login
  44. passwordeval \"pass $pass_prefix$fulladdr\"
  45. $starttlsoff
  46. "
  47. mbsync_profile="IMAPStore $fulladdr-remote
  48. Host $imap
  49. Port ${iport:-993}
  50. User $login
  51. PassCmd \"pass $pass_prefix$fulladdr\"
  52. AuthMechs LOGIN
  53. SSLType ${ssltype:-IMAPS}
  54. CertificateFile $sslcert
  55. MaildirStore $fulladdr-local
  56. Subfolders Verbatim
  57. Path ${XDG_DATA_HOME:-$HOME/.local/share}/mail/$fulladdr/
  58. Inbox ${XDG_DATA_HOME:-$HOME/.local/share}/mail/$fulladdr/INBOX
  59. Flatten .
  60. Channel $fulladdr
  61. Expunge Both
  62. Master :$fulladdr-remote:
  63. Slave :$fulladdr-local:
  64. Patterns * !\"[Gmail]/All Mail\"
  65. Create Both
  66. SyncState *
  67. MaxMessages ${maxmes:-0}
  68. ExpireUnread no
  69. # End profile
  70. "
  71. if [ -z "${online+x}" ]; then
  72. mutt_profile="# vim: filetype=neomuttrc
  73. # muttrc file for account $fulladdr
  74. set realname = \"$realname\"
  75. set from = \"$fulladdr\"
  76. set sendmail = \"msmtp -a $fulladdr\"
  77. alias me $realname <$fulladdr>
  78. set folder = \"$maildir/$fulladdr\"
  79. set header_cache = $cachedir/$fulladdr/headers
  80. set message_cachedir = $cachedir/$fulladdr/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>mw -y $fulladdr<enter>\" \"run mbsync to sync $fulladdr\"
  88. unmailboxes *
  89. "
  90. else
  91. mutt_profile="# vim: filetype=neomuttrc
  92. # muttrc file for account $fulladdr
  93. set realname = \"$realname\"
  94. set from = \"$fulladdr\"
  95. set sendmail = \"msmtp -a $fulladdr\"
  96. alias me $realname <$fulladdr>
  97. set folder = \"imaps://$login@$imap:${iport:-993}\"
  98. set imap_user = \"$login\"
  99. set header_cache = $cachedir/$fulladdr/headers
  100. set message_cachedir = $cachedir/$fulladdr/bodies
  101. set imap_pass = \"\`pass $pass_prefix$fulladdr\`\"
  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. }
  114. parsedomains(){ serverinfo="$(grep "^${fulladdr#*@}" "$muttshare/domains.csv" 2>/dev/null)"
  115. [ -z "$serverinfo" ] && serverinfo="$(grep "$(echo "${fulladdr#*@}" | sed "s/\.[^\.]*$/\.\\\*/")" "$muttshare/domains.csv" 2>/dev/null)"
  116. IFS=, read -r service imapsugg iportsugg smtpsugg sportsugg <<EOF
  117. $serverinfo
  118. EOF
  119. imap="${imap:-$imapsugg}"
  120. smtp="${smtp:-$smtpsugg}"
  121. sport="${sport:-$sportsugg}"
  122. iport="${iport:-$iportsugg}"
  123. }
  124. delete() { if [ -z "${fulladdr+x}" ]; then
  125. echo "Select the account your would like to delete (by number):"
  126. list
  127. read -r input
  128. match="^$input:"
  129. else
  130. match=" $fulladdr$"
  131. getaccounts
  132. fi
  133. fulladdr="$(echo "$accounts" | grep "$match" | cut -f2 -d' ')"
  134. [ -z "$fulladdr" ] && echo "Invalid account name given." && return 1
  135. sed -ibu "/IMAPStore $fulladdr-remote$/,/# End profile/d" "$mbsyncrc" ; rm -rf "$mbsyncrc"bu
  136. rm -rf "${cachedir:?}/${fulladdr:?}" "$accdir/"[1-9]"-$fulladdr.muttrc"
  137. sed -ibu "/[0-9]-$fulladdr.muttrc/d" "$muttrc" ; rm -f "$muttrc"bu
  138. sed -ibu "/account $fulladdr/,/^\(\s*$\|account\)/d" "$msmtprc"; rm -f "$msmtprc"bu
  139. pass rm -f "$pass_prefix$fulladdr" >/dev/null 2>&1
  140. }
  141. askinfo() { \
  142. [ -z "$fulladdr" ] && echo "Give the full email address to add:" &&
  143. read -r fulladdr
  144. while ! echo "$fulladdr" | grep -qE "$emailre"; do
  145. echo "\`$fulladdr\` is not a valid email address. Please retype the address:"
  146. read -r fulladdr
  147. done
  148. { [ -z "$imap" ] || [ -z "$smtp" ] ;} && parsedomains
  149. [ -z "$imap" ] && echo "Give your email server's IMAP address (excluding the port number):" &&
  150. read -r imap
  151. [ -z "$smtp" ] && echo "Give your email server's SMTP address (excluding the port number):" &&
  152. read -r smtp
  153. [ "$sport" = 465 ] && starttlsoff="tls_starttls off"
  154. [ -z "$realname" ] && echo "Give the name you would like to be identified by on the email account:" &&
  155. read -r realname
  156. login="${login:-$fulladdr}"
  157. if [ -n "${password+x}" ]; then
  158. createpass
  159. else
  160. getpass
  161. fi
  162. }
  163. createpass() { echo "$password" > "$PASSWORD_STORE_DIR/$pass_prefix$fulladdr"
  164. "$GPG" -qer "$(cat "$PASSWORD_STORE_DIR/.gpg-id")" "$PASSWORD_STORE_DIR/$pass_prefix$fulladdr"
  165. rm -f "$PASSWORD_STORE_DIR/$pass_prefix$fulladdr" ;}
  166. writeinfo() { mkdir -p "$muttdir" "$accdir" "$cachedir/$fulladdr/bodies" "${XDG_CONFIG_HOME:-$HOME/.config}/msmtp" "$maildir/$fulladdr"
  167. # Get accounts and find the first missing account number (max. 9).
  168. getaccounts; for x in $(seq 1 9); do echo "$accounts" | grep -q "$x" || { export idnum="$x"; break ;}; done
  169. # Configure msmtprc for sending mail.
  170. [ ! -f "$msmtprc" ] && echo "$msmtp_header" > "$msmtprc"
  171. echo "$msmtp_profile" >> "$msmtprc"
  172. # On Ubuntu/Debian, a link is needed since they use an older version.
  173. command -V apt-get >/dev/null 2>&1 && ln -s "$msmtprc" "$HOME/.msmtprc" 2>/dev/null
  174. # Create the mbsync config file.
  175. mkdir -p "${mbsyncrc%/*}"
  176. echo "$mbsync_profile" >> "$mbsyncrc"
  177. # Create a muttrc for viewing mail.
  178. echo "$mutt_profile" > "$accdir/$idnum-$fulladdr.muttrc"
  179. [ ! -f "$muttrc" ] && echo "# vim: filetype=neomuttrc" > "$muttrc"
  180. ! grep -q "^source.*mutt-wizard.muttrc" "$muttrc" && echo "source $mwconfig $MARKER" >> "$muttrc"
  181. ! grep "^source.*.muttrc" "$muttrc" | grep -qv "$mwconfig" && echo "source $accdir/$idnum-$fulladdr.muttrc $MARKER" >> "$muttrc"
  182. echo "macro index,pager i$idnum '<sync-mailbox><enter-command>source $accdir/$idnum-$fulladdr.muttrc<enter><change-folder>!<enter>;<check-stats>' \"switch to $fulladdr\" $MARKER" >> "$muttrc"
  183. notmuchauto # Create a notmuch config file if not present already.
  184. }
  185. protonfinger() { printf "Getting Protonmail bridge fingerprint...\\n"
  186. fingerprint="$(msmtp --serverinfo --host=$smtp --port=$sport --tls --tls-certcheck=off | grep SHA256: | sed 's/^.*: //')"
  187. sed -ibu "s/account $fulladdr/&\ntls_trust_file\ntls_fingerprint $fingerprint/" "$msmtprc" ; rm -f "$msmtprc"bu ;}
  188. getpass() { while : ; do pass rm -f "$pass_prefix$fulladdr" >/dev/null 2>&1
  189. pass insert "$pass_prefix$fulladdr" && break; done ;}
  190. formatShortcut() { toappend="$toappend
  191. macro index,pager g$1 \"<change-folder>=$3<enter>\" \"go to $2\" $MARKER
  192. macro index,pager M$1 \";<save-message>=$3<enter>\" \"move mail to $2\" $MARKER
  193. macro index,pager C$1 \";<copy-message>=$3<enter>\" \"copy mail to $2\" $MARKER" >> "$accdir/$idnum-$fulladdr.muttrc" ;}
  194. setBox() { toappend="$toappend
  195. set $1 = \"+$2\" $MARKER" ;}
  196. getboxes() { [ -n "${force+x}" ] && mailboxes="INBOX
  197. Drafts
  198. Junk
  199. Trash
  200. Sent
  201. Archive" && return 0
  202. if mailboxes="$(mbsync -l "$fulladdr" | sed 's/\//./')" >/dev/null 2>&1 && [ -n "$mailboxes" ]; then
  203. [ "$accounttype" = "online" ] && sed -ibu "/IMAPStore $fulladdr-remote$/,/# End profile/d" "$mbsyncrc" ; rm -f "$mbsyncrc"bu
  204. return 0
  205. else
  206. echo "$mailboxes"
  207. 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"
  208. return 1
  209. fi ;}
  210. finalize() { echo "$mailboxes" | xargs -I {} mkdir -p "$maildir/$fulladdr/{}/cur" "$maildir/$fulladdr/{}/tmp" "$maildir/$fulladdr/{}/new"
  211. sed -ibu "/$MARKER/d" "$accdir/$idnum-$fulladdr.muttrc" ; rm -f "$accdir/$idnum-$fulladdr.muttrcbu"
  212. toappend="mailboxes $(echo "$mailboxes" | sed "s/^/\"=/;s/$/\"/" | paste -sd ' ' )"
  213. for x in $mailboxes; do
  214. case $x in
  215. *[Ii][Nn][Bb][Oo][Xx]*) formatShortcut i inbox "$x"; setBox spoolfile "$x" ;;
  216. *[Ss][Ee][Nn][Tt]*) setBox record "$x"; formatShortcut s sent "$x" ;;
  217. *[Dd][Rr][Aa][Ff][Tt][Ss]*) setBox postponed "$x"; formatShortcut d drafts "$x" ;;
  218. *[Tt][Rr][Aa][Ss][Hh]*) formatShortcut t trash "$x"; setBox trash "$x" ;;
  219. *[Jj][Uu][Nn][Kk]*) formatShortcut j junk "$x" ;;
  220. *[Aa][Rr][Cc][Hh][Ii][Vv][Ee]*) formatShortcut a archive "$x" ;;
  221. *[Ss][Pp][Aa][Mm]*) formatShortcut S spam "$x" ;;
  222. esac
  223. done
  224. echo "$toappend" >> "$accdir/$idnum-$fulladdr.muttrc"
  225. [ -z "${online+x}" ] && printf "\033[33mYou should now be able to run \`\033[32mmw -y %s\033[33m\` to begin to download your mail.\033[0m\\n" "$fulladdr"
  226. command -V urlview >/dev/null 2>&1 && [ ! -f "$HOME/.urlview" ] && echo "COMMAND \$BROWSER" > "$HOME/.urlview"
  227. return 0 ;}
  228. syncwrapper() { mbsync "${1:--a}" &
  229. ( kill -46 "$(pidof "${STATUSBAR:-dwmblocks}")" >/dev/null 2>&1 ) 2>/dev/null
  230. wait
  231. ( kill -46 "$(pidof "${STATUSBAR:-dwmblocks}")" >/dev/null 2>&1 ) 2>/dev/null
  232. notmuch new ;}
  233. notmuchauto() { \
  234. [ -z "$NOTMUCH_CONFIG" ] && NOTMUCH_CONFIG="$HOME/.notmuch-config"
  235. [ -f "$NOTMUCH_CONFIG" ] && return 0
  236. nmbasic="[database]
  237. path=$maildir
  238. [user]
  239. name=$realname
  240. primary_email=$fulladdr
  241. [new]
  242. tags=unread;inbox;
  243. ignore=.mbsyncstate;.uidvalidity
  244. [search]
  245. exclude_tags=deleted;spam;
  246. [maildir]
  247. synchronize_flags=true
  248. [crypto]
  249. gpg_path=$GPG"
  250. echo "$nmbasic" > "$NOTMUCH_CONFIG" ;}
  251. setact() { if [ -n "${action+x}" ] && [ "$action" != "$1" ]; then
  252. echo "Running $1 with $action..."
  253. echo "Incompatible options given. Only one action may be specified per run."
  254. return 1
  255. else
  256. action="$1"
  257. fi; }
  258. trap 'echo -e "\033[0m\n"; exit' INT ABRT
  259. while getopts "fplhdYD:y:i:I:s:S:u:a:n:x:" o; do case "${o}" in
  260. l) setact list || exit 1 ;;
  261. d) setact delete || exit 1 ;;
  262. D) setact delete || exit 1 ; fulladdr="$OPTARG" ;;
  263. y) setact sync || exit 1 ; fulladdr="$OPTARG" ;;
  264. Y) setact sync || exit 1 ;;
  265. a) setact add || exit 1 ; fulladdr="$OPTARG" ;;
  266. i) setact add || exit 1 ; imap="$OPTARG" ;;
  267. I) setact add || exit 1 ; iport="$OPTARG" ;;
  268. s) setact add || exit 1 ; smtp="$OPTARG" ;;
  269. S) setact add || exit 1 ; sport="$OPTARG" ;;
  270. u) setact add || exit 1 ; login="$OPTARG" ;;
  271. n) setact add || exit 1 ; realname="$OPTARG" ;;
  272. m) setact add || exit 1 ; maxmes="$OPTARG" ;;
  273. o) setact add || exit 1 ; online=True ;;
  274. f) setact add || exit 1 ; force=True ;;
  275. x) setact add || exit 1 ; password="$OPTARG" ;;
  276. p) echo "NOTE: Protonmail users must install and configure Protonmail Bridge first for the first sync to work."
  277. proton=True
  278. imap="127.0.0.1"
  279. iport="1143"
  280. smtp="127.0.0.1"
  281. sport="1025"
  282. ssltype="None"
  283. protonfinger
  284. setact add || exit 1
  285. ;;
  286. *) cat << EOF
  287. mw: mutt-wizard, auto-configure email accounts for mutt
  288. including downloadable mail with \`isync\`.
  289. Main actions:
  290. -a your@email.com Add an email address
  291. -l List email addresses configured
  292. -d Remove an already added address
  293. -D your@email.com Force remove account without confirmation
  294. -y your@email.com Sync mail for account by name
  295. -Y Sync mail for all accounts
  296. Options allowed with -a:
  297. -u Account login name if not full address.
  298. -n "Real name" to be on the email account.
  299. -i IMAP server address
  300. -I IMAP server port
  301. -s SMTP server address
  302. -S SMTP server port
  303. -p Install for a Protonmail account.
  304. -o Configure address, but keep mail online.
  305. -b Assume typical English mailboxes without attempting log-on.
  306. NOTE: Once at least one account is added, you can run
  307. \`mbsync -a\` to begin downloading mail.
  308. To chane an account's password, run \`pass edit ${pass_prefix}your@email.com\`.
  309. EOF
  310. exit 1
  311. ;;
  312. esac done
  313. ! command -v mbsync >/dev/null && [ -z "${force+x}" ] && printf "\`mbsync (isync package)\` must be installed to run mutt-wizard.\\n" && exit
  314. case "$action" in
  315. list) list ;;
  316. add) askinfo && getprofiles && writeinfo && getboxes && finalize || delete ;;
  317. delete) delete $fulladdr ;;
  318. sync) syncwrapper $fulladdr ;;
  319. esac