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.
 
 
 
 

363 lines
13 KiB

  1. #!/bin/sh
  2. prefix="/usr/local"
  3. maildir="${XDG_DATA_HOME:-$HOME/.local/share}/mail"
  4. muttshare="$prefix/share/mutt-wizard"
  5. cachedir="${XDG_CACHE_HOME:-$HOME/.cache}/mutt-wizard"
  6. muttrc="${XDG_CONFIG_HOME:-$HOME/.config}/mutt/muttrc"
  7. accdir="${XDG_CONFIG_HOME:-$HOME/.config}/mutt/accounts"
  8. msmtprc="${XDG_CONFIG_HOME:-$HOME/.config}/msmtp/config"
  9. msmtplog="${XDG_CONFIG_HOME:-$HOME/.config}/msmtp/msmtp.log"
  10. mbsyncrc="${MBSYNCRC:-$HOME/.mbsyncrc}"
  11. mpoprc="${XDG_CONFIG_HOME:-$HOME/.config}/mpop/config"
  12. alias mbsync='mbsync -c "$mbsyncrc"'
  13. 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/"; do
  14. [ -f "$x" ] && sslcert="$x" && break
  15. done || { echo "CA Certificate not found. Please install one or link it to /etc/ssl/certs/ca-certificates.crt" && exit 1 ;}
  16. checkbasics() { command -V gpg >/dev/null 2>&1 && GPG="gpg" || GPG="gpg2"
  17. PASSWORD_STORE_DIR="${PASSWORD_STORE_DIR:-$HOME/.password-store}"
  18. [ -r "$PASSWORD_STORE_DIR/.gpg-id" ] &&
  19. "$GPG" --list-secret-keys "$(cat "$PASSWORD_STORE_DIR/.gpg-id")" >/dev/null 2>&1 || {
  20. echo "First run \`pass init <yourgpgemail>\` to set up a password archive."
  21. echo "(If you don't already have a GPG key pair, first run \`$GPG --full-generate-key\`.)"
  22. exit 1 ;} ;}
  23. getaccounts() { accounts="$(find -L "$accdir" -type f 2>/dev/null | grep -o "[0-9]-.*.muttrc" | sed "s/-/: /;s/\.muttrc$//" | sort -n)" ;}
  24. list() { getaccounts && [ -n "$accounts" ] && echo "$accounts" || exit 1 ;}
  25. prepmsmtp() { echo "account $fulladdr
  26. host $smtp
  27. port ${sport:-587}
  28. from $fulladdr
  29. user $login
  30. passwordeval \"pass $fulladdr\"
  31. auth ${auth:-on}
  32. ${tlsline:-tls on}
  33. tls_trust_file $sslcert
  34. logfile $msmtplog
  35. " >> "$msmtprc"
  36. # On Ubuntu/Debian, a link is needed since they use an older version.
  37. command -V apt-get >/dev/null 2>&1 && ln -s "$msmtprc" "$HOME/.msmtprc" 2>/dev/null
  38. }
  39. prepmbsync() { mkdir -p "${mbsyncrc%/*}"
  40. echo "
  41. IMAPStore $fulladdr-remote
  42. Host $imap
  43. Port ${iport:-993}
  44. User $login
  45. PassCmd \"pass $fulladdr\"
  46. AuthMechs LOGIN
  47. SSLType ${imapssl:-IMAPS}
  48. CertificateFile $sslcert
  49. MaildirStore $fulladdr-local
  50. Subfolders Verbatim
  51. Path ${XDG_DATA_HOME:-$HOME/.local/share}/mail/$fulladdr/
  52. Inbox ${XDG_DATA_HOME:-$HOME/.local/share}/mail/$fulladdr/${inbox:-INBOX}
  53. Channel $fulladdr
  54. Expunge Both
  55. Master :$fulladdr-remote:
  56. Slave :$fulladdr-local:
  57. Patterns * !\"[Gmail]/All Mail\"
  58. Create Both
  59. SyncState *
  60. MaxMessages ${maxmes:-0}
  61. ExpireUnread no
  62. # End profile
  63. " >> "$mbsyncrc" ;}
  64. prepmpop() { mkdir -p "${mpoprc%/*}"
  65. echo "
  66. account $fulladdr
  67. tls on
  68. user $login
  69. host $imap
  70. delivery maildir ${XDG_DATA_HOME:-$HOME/.local/share}/mail/$fulladdr/${inbox:-INBOX}
  71. passwordeval pass $fulladdr
  72. " >> "$mpoprc" ;}
  73. prepmutt() { echo "# vim: filetype=neomuttrc
  74. # muttrc file for account $fulladdr
  75. set realname = \"$realname\"
  76. set from = \"$fulladdr\"
  77. set sendmail = \"msmtp -a $fulladdr\"
  78. alias me $realname <$fulladdr>
  79. set folder = \"$folder\"
  80. set header_cache = $cachedir/$fulladdr/headers
  81. set message_cachedir = $cachedir/$fulladdr/bodies
  82. set mbox_type = Maildir
  83. $extra
  84. bind index,pager gg noop
  85. bind index,pager g noop
  86. bind index,pager M noop
  87. bind index,pager C noop
  88. bind index gg first-entry
  89. unmailboxes *
  90. unalternates *
  91. unset signature
  92. $synccmd
  93. " > "$accdir/$idnum-$fulladdr.muttrc"
  94. [ ! -f "$muttrc" ] && echo "# vim: filetype=neomuttrc" > "$muttrc"
  95. ! grep -q "^source.*mutt-wizard.muttrc" "$muttrc" && echo "source $muttshare/mutt-wizard.muttrc" >> "$muttrc"
  96. ! grep "^source.*.muttrc" "$muttrc" | grep -qv "$muttshare/mutt-wizard.muttrc" && echo "source $accdir/$idnum-$fulladdr.muttrc" >> "$muttrc"
  97. echo "macro index,pager i$idnum '<sync-mailbox><enter-command>source $accdir/$idnum-$fulladdr.muttrc<enter><change-folder>!<enter>;<check-stats>' \"switch to $fulladdr\"" >> "$muttrc"
  98. }
  99. getprofiles() { \
  100. mkdir -p "${muttrc%/*}" "$accdir" "$cachedir/$fulladdr/bodies" "${XDG_CONFIG_HOME:-$HOME/.config}/msmtp"
  101. unset msmtp_header msmtp_profile mutt_profile mbsync_profile
  102. case "$iport" in
  103. 1143) imapssl=None ;;
  104. 143) imapssl=STARTTLS ;;
  105. esac
  106. case "$type" in
  107. online) folder="imaps://$login@$imap:${iport:-993}"
  108. extra="set imap_user = \"$login\"
  109. set imap_pass = \"\`pass $fulladdr\`\"
  110. set ssl_starttls = yes
  111. set ssl_force_tls = yes"
  112. ;;
  113. pop) synccmd="macro index o \"<shell-escape>mpop $fulladdr<enter>\" \"run mpop to get $fulladdr's mail\""
  114. folder="$maildir/$fulladdr"
  115. prepmpop ;;
  116. *) synccmd="macro index o \"<shell-escape>mbsync $fulladdr<enter>\" \"run mbsync to sync $fulladdr\""
  117. folder="$maildir/$fulladdr"
  118. prepmbsync ;;
  119. esac
  120. prepmsmtp
  121. prepmutt
  122. prepnotmuch # Create a notmuch config file if not present already.
  123. }
  124. parsedomains(){ serverinfo="$(grep "^${fulladdr#*@}" "$muttshare/domains.csv" 2>/dev/null)"
  125. [ -z "$serverinfo" ] && serverinfo="$(grep "$(echo "${fulladdr#*@}" | sed "s/\.[^\.]*$/\.\\\*/")" "$muttshare/domains.csv" 2>/dev/null)"
  126. IFS=, read -r service imapsugg iportsugg smtpsugg sportsugg <<EOF
  127. $serverinfo
  128. EOF
  129. imap="${imap:-$imapsugg}"
  130. smtp="${smtp:-$smtpsugg}"
  131. sport="${sport:-$sportsugg}"
  132. iport="${iport:-$iportsugg}"
  133. }
  134. delete() { if [ -z "${fulladdr+x}" ]; then
  135. echo "Select the account you would like to delete (by number):"
  136. list || exit 1
  137. read -r input
  138. match="^$input:"
  139. else
  140. match=" $fulladdr$"
  141. getaccounts
  142. fi
  143. fulladdr="$(echo "$accounts" | grep "$match" | cut -f2 -d' ')"
  144. [ -z "$fulladdr" ] && echo "$fulladdr is not a valid account name." && return 1
  145. sed -ibu "/IMAPStore $fulladdr-remote$/,/# End profile/d" "$mbsyncrc" 2>/dev/null ; rm -f "$mbsyncrc"bu
  146. rm -rf "${cachedir:?}/${fulladdr:?}" "$accdir/"[1-9]"-$fulladdr.muttrc"
  147. sed -ibu "/[0-9]-$fulladdr.muttrc/d" "$muttrc" 2>/dev/null; rm -f "$muttrc"bu
  148. sed -ibu "/account $fulladdr$/,/^\(\s*$\|account\)/d" "$msmtprc" 2>/dev/null; rm -f "$msmtprc"bu
  149. sed -ibu "/account $fulladdr$/,/^\(\s*$\|account\)/d" "$mpoprc" 2>/dev/null; rm -f "$mpoprc"bu
  150. pass rm -f "$fulladdr" >/dev/null 2>&1
  151. [ -n "${purge+x}" ] && rm -rf "${maildir:?}/${fulladdr:?}"
  152. for file in "$msmtprc" "$mbsyncrc" "$mpoprc"; do
  153. sed -ibu 'N;/^\n$/D;P;D;' "$file" 2>/dev/null; rm -f "$file"bu
  154. done
  155. }
  156. askinfo() { \
  157. [ -z "$fulladdr" ] && echo "Give the full email address to add:" &&
  158. read -r fulladdr
  159. while ! echo "$fulladdr" | grep -qE "^.+@.+\.[A-Za-z]+$"; do
  160. echo "\`$fulladdr\` is not a valid email address. Please retype the address:"
  161. read -r fulladdr
  162. done
  163. getaccounts; echo "$accounts" | grep -q "\s$fulladdr$" 2>/dev/null &&
  164. { echo "$fulladdr has already been added" && exit 1 ;}
  165. { [ -z "$imap" ] || [ -z "$smtp" ] ;} && parsedomains
  166. [ -z "$imap" ] && echo "Give your email server's IMAP address (excluding the port number):" &&
  167. read -r imap
  168. [ -z "$smtp" ] && echo "Give your email server's SMTP address (excluding the port number):" &&
  169. read -r smtp
  170. [ "$sport" = 465 ] && tlsline="tls_starttls off"
  171. [ -z "$realname" ] && realname="${fulladdr%%@*}"
  172. login="${login:-$fulladdr}"
  173. if [ -n "${password+x}" ]; then
  174. createpass
  175. else
  176. getpass
  177. fi
  178. }
  179. createpass() { echo "$password" > "$PASSWORD_STORE_DIR/$fulladdr"
  180. "$GPG" -qer "$(cat "$PASSWORD_STORE_DIR/.gpg-id")" "$PASSWORD_STORE_DIR/$fulladdr"
  181. rm -f "$PASSWORD_STORE_DIR/$fulladdr" ;}
  182. getpass() { while : ; do pass rm -f "$fulladdr" >/dev/null 2>&1
  183. pass insert -f "$fulladdr" && break; done ;}
  184. formatShortcut() { toappend="$toappend
  185. macro index,pager g$1 \"<change-folder>=$3<enter>\" \"go to $2\"
  186. macro index,pager M$1 \";<save-message>=$3<enter>\" \"move mail to $2\"
  187. macro index,pager C$1 \";<copy-message>=$3<enter>\" \"copy mail to $2\"" ;}
  188. setBox() { toappend="$toappend
  189. set $1 = \"+$2\"" ;}
  190. getboxes() { if [ -n "${force+x}" ] ; then
  191. mailboxes="$(printf "INBOX\\nDrafts\\nJunk\\nTrash\\nSent\\nArchive")"
  192. else
  193. info="$(curl --location-trusted -s -m 5 --user "$login:$(pass "$fulladdr")" --url "${protocol:-imaps}://$imap:${iport:-993}")"
  194. [ -z "$info" ] && echo "Log-on not successful." && return 1
  195. mailboxes="$(echo "$info" | grep -v HasChildren | sed "s/.*\" //;s/\"//g" | tr -d ' ')"
  196. fi
  197. [ "$type" = "pop" ] && mailboxes="INBOX"
  198. getaccounts; for x in $(seq 1 9); do echo "$accounts" | grep -q "^$x:" || { export idnum="$x"; break ;}; done
  199. toappend="mailboxes $(echo "$mailboxes" | sed "s/^/\"=/;s/$/\"/" | paste -sd ' ' - )"
  200. for x in $mailboxes; do
  201. case "$x" in
  202. *[Ss][Ee][Nn][Tt]*) setBox record "$x"; formatShortcut s sent "$x" ;;
  203. *[Dd][Rr][Aa][Ff][Tt][Ss]*) setBox postponed "$x"; formatShortcut d drafts "$x" ;;
  204. *[Tt][Rr][Aa][Ss][Hh]*) formatShortcut t trash "$x"; setBox trash "$x" ;;
  205. *[Jj][Uu][Nn][Kk]*) formatShortcut j junk "$x" ;;
  206. *[Aa][Rr][Cc][Hh][Ii][Vv][Ee]*) formatShortcut a archive "$x" ;;
  207. *[Ss][Pp][Aa][Mm]*) formatShortcut S spam "$x" ;;
  208. *[Ii][Nn][Bb][Oo][Xx]) formatShortcut i inbox "$x"; setBox spoolfile "$x" inbox="$x" ;;
  209. esac
  210. done
  211. }
  212. finalize() { echo "$toappend" >> "$accdir/$idnum-$fulladdr.muttrc"
  213. [ "$type" != "online" ] && echo "$mailboxes" | xargs -I {} mkdir -p "$maildir/$fulladdr/{}/cur" "$maildir/$fulladdr/{}/tmp" "$maildir/$fulladdr/{}/new"
  214. echo "$fulladdr (account #$idnum) added successfully."
  215. command -V urlview >/dev/null 2>&1 && [ ! -f "$HOME/.urlview" ] && echo "COMMAND \$BROWSER" > "$HOME/.urlview"
  216. return 0 ;}
  217. prepnotmuch() { \
  218. [ -z "$NOTMUCH_CONFIG" ] && NOTMUCH_CONFIG="$HOME/.notmuch-config"
  219. [ -f "$NOTMUCH_CONFIG" ] && return 0
  220. nmbasic="[database]
  221. path=$maildir
  222. [user]
  223. name=$realname
  224. primary_email=$fulladdr
  225. [new]
  226. tags=unread;inbox;
  227. ignore=.mbsyncstate;.uidvalidity
  228. [search]
  229. exclude_tags=deleted;spam;
  230. [maildir]
  231. synchronize_flags=true
  232. [crypto]
  233. gpg_path=$GPG"
  234. echo "$nmbasic" > "$NOTMUCH_CONFIG" ;}
  235. togglecron() { cron="$(mktemp)"
  236. crontab -l > "$cron"
  237. if grep -q mailsync "$cron"; then
  238. echo "Removing automatic mailsync..."
  239. sed -ibu /mailsync/d "$cron"; rm -f "$cron"bu
  240. else
  241. echo "Adding automatic mailsync every ${cronmin:-10} minutes..."
  242. echo "*/${cronmin-10} * * * * $prefix/bin/mailsync" >> "$cron"
  243. fi &&
  244. crontab "$cron"; rm -f "$cron" ;}
  245. setact() { if [ -n "${action+x}" ] && [ "$action" != "$1" ]; then
  246. echo "Running $1 with $action..."
  247. echo "Incompatible options given. Only one action may be specified per run."
  248. return 1
  249. else
  250. action="$1"
  251. fi; }
  252. mwinfo() { cat << EOF
  253. mw: mutt-wizard, auto-configure email accounts for mutt
  254. including downloadable mail with \`isync\`.
  255. Main actions:
  256. -a your@email.com Add an email address
  257. -l List email addresses configured
  258. -d Remove an already added address
  259. -D your@email.com Force remove account without confirmation
  260. -y your@email.com Sync mail for account by name
  261. -Y Sync mail for all accounts
  262. -t number Toggle automatic mailsync every <number> minutes
  263. -T Toggle automatic mailsync
  264. Options allowed with -a:
  265. -u Account login name if not full address
  266. -n "Real name" to be on the email account
  267. -i IMAP/POP server address
  268. -I IMAP/POP server port
  269. -s SMTP server address
  270. -S SMTP server port
  271. -x Password for account (recommended to be in double quotes)
  272. -p Install for a Protonmail account.
  273. -P Add for a POP server instead of IMAP.
  274. -X Delete an account's local email too when deleting.
  275. -o Configure address, but keep mail online.
  276. -f Assume typical English mailboxes without attempting log-on.
  277. NOTE: Once at least one account is added, you can run
  278. \`mbsync -a\` to begin downloading mail.
  279. To change an account's password, run \`pass edit your@email.com\`.
  280. EOF
  281. }
  282. while getopts "fpPXlhodTYD:y:i:I:s:S:u:a:n:x:m:t:" o; do case "${o}" in
  283. l) setact list || exit 1 ;;
  284. d) setact delete || exit 1 ;;
  285. D) setact delete || exit 1 ; fulladdr="$OPTARG" ;;
  286. y) setact sync || exit 1 ; fulladdr="$OPTARG" ;;
  287. Y) setact sync || exit 1 ;;
  288. a) setact add || exit 1 ; fulladdr="$OPTARG" ;;
  289. i) setact add || exit 1 ; imap="$OPTARG" ;;
  290. I) setact add || exit 1 ; iport="$OPTARG" ;;
  291. s) setact add || exit 1 ; smtp="$OPTARG" ;;
  292. S) setact add || exit 1 ; sport="$OPTARG" ;;
  293. u) setact add || exit 1 ; login="$OPTARG" ;;
  294. n) setact add || exit 1 ; realname="$OPTARG" ;;
  295. m) setact add || exit 1 ; maxmes="$OPTARG" ;;
  296. o) setact add || exit 1 ; type="online" ;;
  297. P) setact add || exit 1 ; type="pop"; protocol="pop3s" ; iport="${iport:-995}" ;;
  298. f) setact add || exit 1 ; force=True ;;
  299. x) setact add || exit 1 ; password="$OPTARG" ;;
  300. X) setact delete || exit 1 ; purge=True ;;
  301. t) setact toggle || exit 1 ; cronmin="$OPTARG" ;;
  302. T) setact toggle || exit 1 ;;
  303. p) echo "NOTE: Protonmail users must install and configure Protonmail Bridge first for the first sync to work."
  304. protocol="imap"
  305. imap="127.0.0.1"
  306. iport="1143"
  307. smtp="127.0.0.1"
  308. sport="1025"
  309. auth="login"
  310. tlsline="tls_fingerprint $(msmtp --serverinfo --host=$smtp --port=$sport --tls --tls-certcheck=off | awk '/SHA256:/ {print $2}')"
  311. setact add || exit 1
  312. ;;
  313. *) mwinfo; exit 1 ;;
  314. esac done
  315. case "$action" in
  316. list) list ;;
  317. add) checkbasics && askinfo && getboxes && getprofiles && finalize ;;
  318. delete) delete ;;
  319. sync) mailsync $fulladdr ;;
  320. toggle) togglecron ;;
  321. *) mwinfo; exit 1 ;;
  322. esac