# muttjump
#
-# This script makes mail indexers (like mairix, mu or nmzmail) together with
-# mutt more useful.
+# This script makes mail indexers (like mairix, mu, nmzmail, or
+# notmuch) together with mutt more useful.
#
# These search engines usually create a virtual maildir containing symbolic
# links to the original mails, which can be browsed using mutt.
#
# macro generic ,j "<enter-command>push <pipe-message>muttjump<enter><enter>" "jump to original message"
-# one of: mairix, mu, mu-old (mu < 0.7) and nmzmail
+# one of: mairix, mairix-git, mu, mu-old (mu < 0.7), nmzmail or notmuch (>0.5)
MUTTJUMP_INDEXER=${MUTTJUMP_INDEXER:-}
# "limit" or "search" (default)
MUTTJUMP_USE_SCREEN=${MUTTJUMP_USE_SCREEN:-auto}
# "yes" or "no"
-# If this is set to "yes", muttjump will not open a new instance of
-# mutt, but instead jump to the original message in a running mutt
-# (which is running in a screen session).
-# ATTENTION: You need to have one mutt instance open for every mailbox
-# for this to work!
+# Set this to "yes" if you want exactly one screen window (with mutt running
+# inside) per mailbox. With new versions of screen (> 4.00) it is possible
+# to do that automatically, with old versions you have to start them
+# manually! Setting this to yes implies MUTTJUMP_USE_SCREEN=yes.
MUTTJUMP_MULTI_SCREEN_MODE=${MUTTJUMP_MULTI_SCREEN_MODE:-no}
# function to create the screen window name from the full path of the mailbox
}
fi
+# Version of GNU screen
+# Since 4.01.00devel (commit 98b6b41) backslash handling for -X was altered.
+MUTTJUMP_SCREEN_VERSION=${MUTTJUMP_SCREEN_VERSION:-auto}
+
# program paths
MUTT=${MUTT:-mutt}
MAIRIX=${MAIRIX:-mairix}
MU=${MU:-mu}
NMZMAIL=${NMZMAIL:-nmzmail}
+NOTMUCH=${NOTMUCH:-notmuch}
SCREEN=${SCREEN:-screen}
FORMAIL=${FORMAIL:-formail}
REFORMAIL=${REFORMAIL:-reformail}
echo \'${1//\'/\'\\\'\'}\'
}
+function quote_regexp () {
+ echo "$1" | sed 's/[][\^.$|)(*+?}{]/\\&/g'
+}
+
function is_callable () {
type $1 >/dev/null 2>&1
}
+function wc_L () {
+ awk '{ y = length(); if (y > x) x = y } END { print x }'
+}
+
+# Check if screen is new enough to parse -X (commit 98b6b41) and support
+# -Q (commit 8147d08). It (falsely) assumes that screen version > 4.00
+# does this. Distributions that use git versions are likely to also keep
+# them up to date.
+function is_new_screen () {
+ sv=$MUTTJUMP_SCREEN_VERSION
+ if [ "$sv" = auto ] ; then
+ sv=$($SCREEN --version | awk '{print $3}')
+ fi
+ echo "$sv" | grep -vq "^\(4\.00\|[0-3]\.\)"
+}
+
function usage () {
cat >&2 <<END
Usage: muttjump msgid
if [ -z "$msgid" ] ; then
die "could not find $search_header header in standard input"
fi
+msgid_quoted=$(quote_regexp "$msgid")
msgid_clean=$(echo "$msgid" | sed -e 's/^<//' -e 's/>$//')
# try to locate path of message using a mail search engine
case $MUTTJUMP_INDEXER in
- mairix)
+ mairix-git)
orig_msgfiles=$($MAIRIX -r "m:$msgid_clean")
;;
+ mairix)
+ msgid_mairix=$msgid_clean
+ # mairix can't quote special characters (~,/=^) in search words. As a
+ # workaround, split Message-ID in 31-character long AND-linked
+ # substrings.
+ if echo "$msgid_clean" | grep -q '[~,/=^]' ; then
+ msgid_mairix=$(echo "$msgid_clean" | sed -e 's/[~,/=^]\+/ /g' \
+ -e 's/[^ ]\{31\}/& /g' -e 's/^ \+//g' -e 's/ *$/=/g' \
+ -e 's/ /=,/g')
+ fi
+ orig_msgfiles=$($MAIRIX -r "m:$msgid_mairix")
+ ;;
mu)
orig_msgfiles=$($MU find -f l "i:$msgid_clean" | grep -v "^\*\*")
;;
;;
nmzmail)
nmzmail_results=$(mktemp -d)
- echo "+message-id:$msgid" | $NMZMAIL -r "$nmzmail_results"
+ echo "+message-id:/^$msgid_quoted$/" | $NMZMAIL -r "$nmzmail_results"
orig_msgfiles=$(find "$nmzmail_results" -type l -exec readlink {} \;)
rm -rf "$nmzmail_results"
;;
+ notmuch)
+ orig_msgfiles=$($NOTMUCH search --output=files "id:$msgid_clean")
+ ;;
"")
die "variable MUTTJUMP_INDEXER not set or empty"
;;
if [ $count -gt 1 -a -n "$DIALOG_PROG" ] ; then
choices=$(echo "$orig_msgfiles" | while read line ;
do dirname "$(dirname "$line")" ; echo . ; done)
- maxwidth=$(echo "$choices" | wc -L)
+ maxwidth=$(echo "$choices" | wc_L)
orig_maildir=$($DIALOG_PROG --clear --title "More than one mailbox found" \
--menu "Select mailbox:" $((count+8)) $((maxwidth+16)) \
$count $choices 3>&2 2>&1 1>&3-)
die "directory $(quote "$orig_maildir") doesn't exist or is no Maildir"
fi
-jump_expr="~i'$msgid'"
+msgid_mutt=$(quote_regexp "$msgid_quoted")
+jump_expr="~i'$msgid_mutt'"
jump_cmd="<limit>$jump_expr<enter>"
if [ "$MUTTJUMP_MODE" = search ] ; then
jump_cmd="$jump_cmd<limit>all<enter>"
fi
-if [ "$MUTTJUMP_MULTI_SCREEN_MODE" = no ] ; then
-
- if [ "$MUTTJUMP_USE_SCREEN" = auto -a -n "$STY" ] ; then
- MUTTJUMP_USE_SCREEN=yes
- fi
+if [ "$MUTTJUMP_MULTI_SCREEN_MODE" = yes ] ||
+ [ "$MUTTJUMP_USE_SCREEN" = auto -a -n "$STY" ] ; then
+ MUTTJUMP_USE_SCREEN=yes
+fi
- screen_opts=()
- if [ "$MUTTJUMP_USE_SCREEN" = yes ] ; then
- if [ -n "$STY" ] ; then
- screen_opts=("-X" "screen")
- else
- reopen_tty
+screen_opts=()
+screen_query_arg=""
+if [ "$MUTTJUMP_USE_SCREEN" = yes ] ; then
+ if [ -n "$STY" ] ; then
+ screen_opts=("-X" "screen")
+ if is_new_screen ; then
+ jump_cmd=${jump_cmd/\\/\\\\\\}
+ screen_query_arg="-Q"
fi
- screen_window_name=$(MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE "$orig_maildir")
- screen_opts=("${screen_opts[@]}" "-t" "$screen_window_name")
else
- SCREEN=""
reopen_tty
fi
-
- # start mutt, open original folder and jump to the original message
- $SCREEN "${screen_opts[@]}" $MUTT -f "$orig_maildir" -e "push \"$jump_cmd\""
-
-else
-
- jump_cmd_short="l$jump_expr\r"
- if [ "$MUTTJUMP_MODE" = search ] ; then
- jump_cmd_short="${jump_cmd_short}lall\r"
- fi
-
screen_window_name=$(MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE "$orig_maildir")
+ screen_opts=("${screen_opts[@]}" "-t" "$screen_window_name")
+else
+ SCREEN=""
+ reopen_tty
+fi
- if [ -z "$STY" ] ; then
- reopen_tty
- $SCREEN -t "$screen_window_name" $MUTT -f "$orig_maildir" -e "push \"$jump_cmd\""
- else
- $SCREEN -X -p "$screen_window_name" -Q select "$screen_window_name" >/dev/null
- if [ $? != 0 ] ; then
- $SCREEN -X screen -t "$screen_window_name" $MUTT -f "$orig_maildir" -e "push \"$jump_cmd\""
- else
- $SCREEN -X -p "$screen_window_name" stuff "$jump_cmd_short"
- fi
+if [ "$MUTTJUMP_MULTI_SCREEN_MODE" = yes -a -n "$STY" ] ; then
+ $SCREEN -X -p "$screen_window_name" $screen_query_arg \
+ select "$screen_window_name" >/dev/null
+ if [ $? = 0 ] ; then
+ $SCREEN -X -p "$screen_window_name" stuff ":push \"$jump_cmd\"\r"
+ exit 0
fi
fi
+
+# start mutt, open original folder and jump to the original message
+$SCREEN "${screen_opts[@]}" $MUTT -f "$orig_maildir" -e "push \"$jump_cmd\""
projects / muttjump / blobdiff