projects.mako.cc - muttjump/blob - muttjump

   1 #!/bin/bash
   2 # written by Johannes Weißl
   3
   4 # muttjump
   5 #
   6 # This script makes mail indexers (like mairix, mu or nmzmail) together with
   7 # mutt more useful.
   8 #
   9 # These search engines usually create a virtual maildir containing symbolic
  10 # links to the original mails, which can be browsed using mutt.
  11 # It would be optimal if mutt somehow knew that the two maildir entries
  12 # identify the same mail, but this is not that easy (mail folder
  13 # abstraction from different formats, no tight integration of mail indexers).
  14 #
  15 # So if one wants to rename (for setting/clearing flags), delete or edit the
  16 # mails, it is only possible using the original mail. This (very simple)
  17 # script helps to jump to this message, using e.g. this macro in .muttrc:
  18 #
  19 # macro generic ,j "<enter-command>push <pipe-message>muttjump<enter><enter>" "jump to original message"
  20
  21 # one of: mairix, mu, mu-old (mu < 0.7) and nmzmail
  22 MUTTJUMP_INDEXER=${MUTTJUMP_INDEXER:-}
  23
  24 # "limit" or "search" (default)
  25 MUTTJUMP_MODE=${MUTTJUMP_MODE:-search}
  26
  27 # "yes" or "no"
  28 # If this is set to "yes", muttjump will not open a new instance of
  29 # mutt, but instead jump to the original message in a running mutt
  30 # (which is running in a screen session).
  31 MUTTJUMP_USE_SCREEN=${MUTTJUMP_USE_SCREEN:-no}
  32
  33 # name of the screen session (screen -S ...), leave blank for none
  34 MUTTJUMP_SCREEN_SESSION=${MUTTJUMP_SCREEN_SESSION:-}
  35
  36 # function to create the screen window name from the full path of the mailbox
  37 if ! type -p MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE >/dev/null ; then
  38     function MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE () {
  39         basename "$1"
  40     }
  41 fi
  42
  43 # program paths
  44 MUTT=${MUTT:-mutt}
  45 MAIRIX=${MAIRIX:-mairix}
  46 MU=${MU:-mu}
  47 NMZMAIL=${NMZMAIL:-nmzmail}
  48 SCREEN=${SCREEN:-screen}
  49
  50 function die () {
  51     echo -e >&2 "$0: $1"
  52     exit 1
  53 }
  54
  55 # Check command-line arguments and STDIN
  56 if tty -s || [ $# -ne 0 ] ; then
  57     cat >&2 <<END
  58 Usage: $0 < msg
  59
  60 This script calls mutt, jumping to the message given in stdin.
  61 Uses a mail search engine (currently mairix, mu and nmzmail are supported),
  62 which has to be configured through MUTTJUMP_INDEXER variable.
  63 END
  64     exit 1
  65 fi
  66
  67 # check if mutt is installed
  68 if ! type -p $MUTT >/dev/null ; then
  69     die "$MUTT is not in PATH, set MUTT variable"
  70 fi
  71
  72 # search for Message-ID in STDIN
  73 msgid=$(sed -n 's/^Message-ID: \(.*\)/\1/Ip' | head -n1)
  74 if [ -z "$msgid" ] ; then
  75     die "could not find Message-ID header in standard input"
  76 fi
  77 msgid_clean=$(echo "$msgid" | sed 's/^<\(.*\)>$/\1/')
  78
  79 # try to locate path of message using a mail search engine
  80 case $MUTTJUMP_INDEXER in
  81     mairix)
  82         orig_msgfile=$($MAIRIX -r "m:$msgid_clean" | head -n1)
  83         ;;
  84     mu)
  85         orig_msgfile=$($MU find -f l "i:$msgid_clean" |
  86             grep -v "^\*\*" | head -n1)
  87         ;;
  88     mu-old)
  89         orig_msgfile=$($MU find -f p "m:$msgid_clean" | head -n1)
  90         ;;
  91     nmzmail)
  92         nmzmail_results=$(mktemp -d)
  93         echo "+message-id:$msgid" | $NMZMAIL -n 1 -r "$nmzmail_results"
  94         msgfile=$(find "$nmzmail_results" -type l | head -n1)
  95         orig_msgfile=$(readlink "$msgfile")
  96         rm -rf "$nmzmail_results"
  97         ;;
  98     "")
  99         die "variable MUTTJUMP_INDEXER not set or empty"
 100         ;;
 101     *)
 102         die "unknown mail index program \"$MUTTJUMP_INDEXER\""
 103         ;;
 104 esac
 105
 106 if [ -z "$orig_msgfile" -o ! -e "$orig_msgfile" ] ; then
 107     die "no message with msgid $msgid found!"
 108 fi
 109
 110 # get containing maildir of $orig_msgfile
 111 orig_maildir=$(dirname $(dirname "$orig_msgfile"))
 112 if [ ! -d "$orig_maildir/cur" ] ; then
 113     die "directory \"$orig_maildir\" doesn't exist or is no Maildir"
 114 fi
 115
 116 jump_cmd="<change-folder>$orig_maildir<enter><$MUTTJUMP_MODE>~i '$msgid'<enter>"
 117
 118 if [ "$MUTTJUMP_USE_SCREEN" = no ] ; then
 119
 120     # Close message-stdin and open terminal-stdin instead.
 121     # mutt behaves different if STDIN is no terminal
 122     # TODO: Find cleaner solution (e.g. mutt command-line argument?)
 123     exec 0<&-
 124     term="/dev/$(ps -p$$ --no-heading | awk '{print $2}')"
 125     exec < $term
 126
 127     # start mutt, open original folder and jump to the original message
 128     $MUTT -e "push \"$jump_cmd\""
 129
 130 else
 131
 132     screen_window_name=$(MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE "$orig_maildir")
 133     screen_opts=""
 134     if [ -n "$MUTTJUMP_SCREEN_SESSION" ] ; then
 135         screen_opts="-S $MUTTJUMP_SCREEN_SESSION"
 136     fi
 137
 138     $SCREEN $screen_opts -X eval "select $screen_window_name" "stuff \":push \\\"$jump_cmd\\\"
 139 \""
 140     if [ $? != 0 ] ; then
 141         die "You have to manually start a screen session with:
 142 $SCREEN $screen_opts -t $screen_window_name $MUTT -f \"$orig_maildir\""
 143     fi
 144 fi