Marty/dotfiles
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Wiki Activity
dotfiles/mail/.local/bin/mail-check

131 lines
2.9 KiB
Text
Raw Normal View History

mail: Add checkmail routine Added script to call for checking mail. Will run individual pre- and post-hooks. (By default, imapfilter and notmuch update.) Simple options can be changed through environment variables: Hooks can be set to different scripts with MBSYNC_PRE and MBSYNC_POST, respectively. Will also run mbsync repeatedly, until it exits without error. By default it will try running it 3 times before giving up, this can be set with MBSYNC_MAX_TRIES. No functional imapfilters have been added yet. mbsync and imapfilter both adhere to the XDG base directory layout (somewhat), checking for their option files in .config/{isync,imapfilter} respectively. Everything still pending changes, the mail eco-system is hard to wrap one's head around.
2020-09-16 16:49:08 +00:00
#!/usr/bin/env sh
# runs mbsync, with pre-hooks and post-hooks
# by default, first runs imapfilter
# and after indexes with notmuch
#
# To run without invoking any hooks or retry attempts,
# run `checkmail raw`
# this will simply invoke a single isync run on all
# boxes with the correct config file set.
#
# for more advanced, per-account/channel hooks, see
# https://sourceforge.net/p/isync/feature-requests/8/
mail: HACK mailcheck update Update `mail-check` script to notify the user both of newly arrived mail, and in case he has to enter his password to sync the mail. HACK the paths and ways of finding out if passwords can be decrypted are static and only applicable to my set up. This needs to be completely revised and newly approached.
2020-09-24 12:23:06 +00:00
# available env vars:
# MBSYNC_MAX_TRIES=3
# MBSYNC_PRE="/bin/usr/cmd-to-run"
# MBSYNC_POST="/bin/usr/cmd-to-run"
# MBSYNC_NOTIFY=1
mail: Fix mail-check hooks Fixed running the hooks for `mail-check`. Command (or variable?) substition prevented the hooks from running completely beforehand, so I moved them to a separate function with the option remaining to call a custom script for them through environment variables. Ideally the env vars (`MBSYNC_PRE` and `MBSYNC_POST`) should only point to a single script each, as more involved commands will presumably fail to execute correctly when whitespace substition is involved. See more explanation here: https://unix.stackexchange.com/a/444949
2020-09-24 08:00:47 +00:00
mail,mpv,qutebrowser,vifm: Fix small issues Added videos directory to vifm quick marks (`v`). Fixed (hopefully) qutebrowser statusbar hiding and showing. Improved mail checking script password file handling by switching the hard-coded path to one still somewhat hard-coded, but encapsulated in a variable to make changing it later on easier. The script is a bit slap-dash anyway, so when refactored should be refactored overall. Added `gallery-dl` handling by mpv, whenever a link starting with `gdl://` is passed in.
2021-03-16 13:37:38 +00:00
PASSWORD_FILE="$HOME/.local/share/pass/misc/aerc-gmail-app-password.gpg"
mail: Fix mail-check hooks Fixed running the hooks for `mail-check`. Command (or variable?) substition prevented the hooks from running completely beforehand, so I moved them to a separate function with the option remaining to call a custom script for them through environment variables. Ideally the env vars (`MBSYNC_PRE` and `MBSYNC_POST`) should only point to a single script each, as more involved commands will presumably fail to execute correctly when whitespace substition is involved. See more explanation here: https://unix.stackexchange.com/a/444949
2020-09-24 08:00:47 +00:00
prehook() {
if [ -n "$MBSYNC_PRE" ]; then
eval "$MBSYNC_PRE"
return 0
fi
imapfilter -c "${XDG_CONFIG_HOME:-/home/marty/.config}/imapfilter/config.lua"
}
posthook() {
if [ -n "$MBSYNC_POST" ]; then
eval "$MBSYNC_POST"
return 0
fi
mail: HACK mailcheck update Update `mail-check` script to notify the user both of newly arrived mail, and in case he has to enter his password to sync the mail. HACK the paths and ways of finding out if passwords can be decrypted are static and only applicable to my set up. This needs to be completely revised and newly approached.
2020-09-24 12:23:06 +00:00
notmuch new 2>/dev/null
mail: Fix mail filtering Fixed correct filtering of inbox stuff in afew (moving archived mails out of inbox, moving trash into GMail Trash).
2020-10-01 07:04:24 +00:00
afew --tag --new
afew --move-mail --new
afew --tag --new
mail: Re-enable tagging by folder for notmuch Should help aerc decide what to show in inbox and what to leave out.
2020-11-13 07:54:24 +00:00
notmuch_foldertags
mail: HACK mailcheck update Update `mail-check` script to notify the user both of newly arrived mail, and in case he has to enter his password to sync the mail. HACK the paths and ways of finding out if passwords can be decrypted are static and only applicable to my set up. This needs to be completely revised and newly approached.
2020-09-24 12:23:06 +00:00
countnew
}
# use notmuch to index incoming mail and set the
# correct number of mails if new ones arrived for notifications
countnew() {
num=$(notmuch count tag:unread and tag:inbox)
HASMAIL="${num:-0}"
mail: Fix mail-check hooks Fixed running the hooks for `mail-check`. Command (or variable?) substition prevented the hooks from running completely beforehand, so I moved them to a separate function with the option remaining to call a custom script for them through environment variables. Ideally the env vars (`MBSYNC_PRE` and `MBSYNC_POST`) should only point to a single script each, as more involved commands will presumably fail to execute correctly when whitespace substition is involved. See more explanation here: https://unix.stackexchange.com/a/444949
2020-09-24 08:00:47 +00:00
}
mail: Add checkmail routine Added script to call for checking mail. Will run individual pre- and post-hooks. (By default, imapfilter and notmuch update.) Simple options can be changed through environment variables: Hooks can be set to different scripts with MBSYNC_PRE and MBSYNC_POST, respectively. Will also run mbsync repeatedly, until it exits without error. By default it will try running it 3 times before giving up, this can be set with MBSYNC_MAX_TRIES. No functional imapfilters have been added yet. mbsync and imapfilter both adhere to the XDG base directory layout (somewhat), checking for their option files in .config/{isync,imapfilter} respectively. Everything still pending changes, the mail eco-system is hard to wrap one's head around.
2020-09-16 16:49:08 +00:00
# fail the routine and optionally send a message why
fail() {
[ -n "$1" ] && echo "$1"
exit 1
}
checkmail() {
mail: HACK mailcheck update Update `mail-check` script to notify the user both of newly arrived mail, and in case he has to enter his password to sync the mail. HACK the paths and ways of finding out if passwords can be decrypted are static and only applicable to my set up. This needs to be completely revised and newly approached.
2020-09-24 12:23:06 +00:00
mbsync -c "${XDG_CONFIG_HOME:-$HOME/.config}/isync/mbsyncrc" -a
mail: Add checkmail routine Added script to call for checking mail. Will run individual pre- and post-hooks. (By default, imapfilter and notmuch update.) Simple options can be changed through environment variables: Hooks can be set to different scripts with MBSYNC_PRE and MBSYNC_POST, respectively. Will also run mbsync repeatedly, until it exits without error. By default it will try running it 3 times before giving up, this can be set with MBSYNC_MAX_TRIES. No functional imapfilters have been added yet. mbsync and imapfilter both adhere to the XDG base directory layout (somewhat), checking for their option files in .config/{isync,imapfilter} respectively. Everything still pending changes, the mail eco-system is hard to wrap one's head around.
2020-09-16 16:49:08 +00:00
}
checkonline() {
# Ping 1.1.1.1 to confirm that we are on the internet
ping -c 1 "1.1.1.1" >/dev/null 2>/dev/null || fail "checkmail can not access the internet."
}
mail: HACK mailcheck update Update `mail-check` script to notify the user both of newly arrived mail, and in case he has to enter his password to sync the mail. HACK the paths and ways of finding out if passwords can be decrypted are static and only applicable to my set up. This needs to be completely revised and newly approached.
2020-09-24 12:23:06 +00:00
# warn user that he has to enter his password in a moment
# to stop catching him offguard or entering something by accident
checkwarnuser() {
mail,mpv,qutebrowser,vifm: Fix small issues Added videos directory to vifm quick marks (`v`). Fixed (hopefully) qutebrowser statusbar hiding and showing. Improved mail checking script password file handling by switching the hard-coded path to one still somewhat hard-coded, but encapsulated in a variable to make changing it later on easier. The script is a bit slap-dash anyway, so when refactored should be refactored overall. Added `gallery-dl` handling by mpv, whenever a link starting with `gdl://` is passed in.
2021-03-16 13:37:38 +00:00
agt=$(gpg2 --decrypt --no-tty --quiet --no-verbose --for-your-eyes-only --pinentry-mode cancel "$PASSWORD_FILE" 2>&1)
mail: HACK mailcheck update Update `mail-check` script to notify the user both of newly arrived mail, and in case he has to enter his password to sync the mail. HACK the paths and ways of finding out if passwords can be decrypted are static and only applicable to my set up. This needs to be completely revised and newly approached.
2020-09-24 12:23:06 +00:00
if echo "$agt" | grep -qE 'No secret key'; then
notify "Mail: Password phrase needed!"
sleep 2.5
fi
}
# send out a notification on new mail, to libnotify and stdout
notifymail() {
[ "${MBSYNC_NOTIFY:-1}" -eq 0 ] && return
if [ "${HASMAIL:-0}" -gt 0 ]; then
notify "($HASMAIL) new mail"
fi
}
notify() {
command -v notify-send >/dev/null && notify-send "$@"
echo "$@"
}
mail: Add checkmail routine Added script to call for checking mail. Will run individual pre- and post-hooks. (By default, imapfilter and notmuch update.) Simple options can be changed through environment variables: Hooks can be set to different scripts with MBSYNC_PRE and MBSYNC_POST, respectively. Will also run mbsync repeatedly, until it exits without error. By default it will try running it 3 times before giving up, this can be set with MBSYNC_MAX_TRIES. No functional imapfilters have been added yet. mbsync and imapfilter both adhere to the XDG base directory layout (somewhat), checking for their option files in .config/{isync,imapfilter} respectively. Everything still pending changes, the mail eco-system is hard to wrap one's head around.
2020-09-16 16:49:08 +00:00
# Routine start
# check
# skip any retries and pre/post hooks, just run mbsync
if [ "$1" = "raw" ]; then
checkmail
exit
fi
mail: Add basic filtering system imapfilter now looks for account information in an accounts.lua file in its configuration directory -- the file should return account information as a table with each account being a top-level entry in the table. A sample spam-moving script has been supplied: For now, it will take a list of sender addresses and put everything in the list from the inbox into the dump directory. An example list of senders has been supplied for testing purposes, but this should eventually be read from a file containing an extensible list of senders (and perhaps even different properties such as subject, etc.) The imapfilter xdg alias has been fixed. Coherence between the imap folder structure and notmuch tagging system still has to be achieved -- either by aerc using the folder structure as a query map, or notmuch tags automatically being applied for specific imap filtering options.
2020-09-17 17:49:53 +00:00
main() {
mail: HACK mailcheck update Update `mail-check` script to notify the user both of newly arrived mail, and in case he has to enter his password to sync the mail. HACK the paths and ways of finding out if passwords can be decrypted are static and only applicable to my set up. This needs to be completely revised and newly approached.
2020-09-24 12:23:06 +00:00
checkwarnuser
mail: Fix mail-check hooks Fixed running the hooks for `mail-check`. Command (or variable?) substition prevented the hooks from running completely beforehand, so I moved them to a separate function with the option remaining to call a custom script for them through environment variables. Ideally the env vars (`MBSYNC_PRE` and `MBSYNC_POST`) should only point to a single script each, as more involved commands will presumably fail to execute correctly when whitespace substition is involved. See more explanation here: https://unix.stackexchange.com/a/444949
2020-09-24 08:00:47 +00:00
prehook
mail: Add basic filtering system imapfilter now looks for account information in an accounts.lua file in its configuration directory -- the file should return account information as a table with each account being a top-level entry in the table. A sample spam-moving script has been supplied: For now, it will take a list of sender addresses and put everything in the list from the inbox into the dump directory. An example list of senders has been supplied for testing purposes, but this should eventually be read from a file containing an extensible list of senders (and perhaps even different properties such as subject, etc.) The imapfilter xdg alias has been fixed. Coherence between the imap folder structure and notmuch tagging system still has to be achieved -- either by aerc using the folder structure as a query map, or notmuch tags automatically being applied for specific imap filtering options.
2020-09-17 17:49:53 +00:00
tries=0
while true; do
if checkmail; then
break
fi
tries=$((tries + 1))
mail: HACK mailcheck update Update `mail-check` script to notify the user both of newly arrived mail, and in case he has to enter his password to sync the mail. HACK the paths and ways of finding out if passwords can be decrypted are static and only applicable to my set up. This needs to be completely revised and newly approached.
2020-09-24 12:23:06 +00:00
if [ $tries -gt "${MBSYNC_MAX_TRIES:-3}" ]; then
mail: Add basic filtering system imapfilter now looks for account information in an accounts.lua file in its configuration directory -- the file should return account information as a table with each account being a top-level entry in the table. A sample spam-moving script has been supplied: For now, it will take a list of sender addresses and put everything in the list from the inbox into the dump directory. An example list of senders has been supplied for testing purposes, but this should eventually be read from a file containing an extensible list of senders (and perhaps even different properties such as subject, etc.) The imapfilter xdg alias has been fixed. Coherence between the imap folder structure and notmuch tagging system still has to be achieved -- either by aerc using the folder structure as a query map, or notmuch tags automatically being applied for specific imap filtering options.
2020-09-17 17:49:53 +00:00
fail "maximum retries reached without success."
fi
done
unset tries
mail: Fix mail-check hooks Fixed running the hooks for `mail-check`. Command (or variable?) substition prevented the hooks from running completely beforehand, so I moved them to a separate function with the option remaining to call a custom script for them through environment variables. Ideally the env vars (`MBSYNC_PRE` and `MBSYNC_POST`) should only point to a single script each, as more involved commands will presumably fail to execute correctly when whitespace substition is involved. See more explanation here: https://unix.stackexchange.com/a/444949
2020-09-24 08:00:47 +00:00
posthook
mail: HACK mailcheck update Update `mail-check` script to notify the user both of newly arrived mail, and in case he has to enter his password to sync the mail. HACK the paths and ways of finding out if passwords can be decrypted are static and only applicable to my set up. This needs to be completely revised and newly approached.
2020-09-24 12:23:06 +00:00
notifymail
mail: Add basic filtering system imapfilter now looks for account information in an accounts.lua file in its configuration directory -- the file should return account information as a table with each account being a top-level entry in the table. A sample spam-moving script has been supplied: For now, it will take a list of sender addresses and put everything in the list from the inbox into the dump directory. An example list of senders has been supplied for testing purposes, but this should eventually be read from a file containing an extensible list of senders (and perhaps even different properties such as subject, etc.) The imapfilter xdg alias has been fixed. Coherence between the imap folder structure and notmuch tagging system still has to be achieved -- either by aerc using the folder structure as a query map, or notmuch tags automatically being applied for specific imap filtering options.
2020-09-17 17:49:53 +00:00
}
mail: Add contacts lookup script Added `mail-searchcontacts` script, which uses notmuch to search for all contacts of the mail database. Can be invoked without any arguments to list *all* contacts of the dataase in descending order of message count. Otherwise, it will filter known contacts, first by prioritizing the 'from:' field, and otherwise by searching through the whole database for the keywords passed in. It will also re-format the results so that the list consists of tab-delineated 'mail name' rows. If there is no name, the row will only contain the bare e-mail address. This format is best accepted by aerc, for which the script is written. aerc uses the contacts script for its address completion in editing e-mail headers. Renamed `checkmail` to `mail-check` to fit the naming scheme of `mail-[action]` for mail scripts, to better be able to group them in the shell.
2020-09-18 07:48:25 +00:00
notmuch_foldertags() {
notmuch tag +dump -inbox -deleted -- folder:Dump and not folder:Inbox
notmuch tag +archived -inbox -deleted -- folder:Archive and not folder:Inbox
notmuch tag +deleted -inbox -archived -- folder:Trash and not folder:Inbox
mail: Re-enable tagging by folder for notmuch Should help aerc decide what to show in inbox and what to leave out.
2020-11-13 07:54:24 +00:00
notmuch tag -inbox -- not folder:Inbox
mail: Add contacts lookup script Added `mail-searchcontacts` script, which uses notmuch to search for all contacts of the mail database. Can be invoked without any arguments to list *all* contacts of the dataase in descending order of message count. Otherwise, it will filter known contacts, first by prioritizing the 'from:' field, and otherwise by searching through the whole database for the keywords passed in. It will also re-format the results so that the list consists of tab-delineated 'mail name' rows. If there is no name, the row will only contain the bare e-mail address. This format is best accepted by aerc, for which the script is written. aerc uses the contacts script for its address completion in editing e-mail headers. Renamed `checkmail` to `mail-check` to fit the naming scheme of `mail-[action]` for mail scripts, to better be able to group them in the shell.
2020-09-18 07:48:25 +00:00
}
mail: Add basic filtering system imapfilter now looks for account information in an accounts.lua file in its configuration directory -- the file should return account information as a table with each account being a top-level entry in the table. A sample spam-moving script has been supplied: For now, it will take a list of sender addresses and put everything in the list from the inbox into the dump directory. An example list of senders has been supplied for testing purposes, but this should eventually be read from a file containing an extensible list of senders (and perhaps even different properties such as subject, etc.) The imapfilter xdg alias has been fixed. Coherence between the imap folder structure and notmuch tagging system still has to be achieved -- either by aerc using the folder structure as a query map, or notmuch tags automatically being applied for specific imap filtering options.
2020-09-17 17:49:53 +00:00
main
Reference in a new issue Copy permalink