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 FORMAIL=${FORMAIL:-formail}
  50 REFORMAIL=${REFORMAIL:-reformail}
  51
  52 function die () {
  53     echo -e >&2 "$0: $1"
  54     exit 1
  55 }
  56
  57 # Check command-line arguments and STDIN
  58 if tty -s || [ $# -ne 0 ] ; then
  59     cat >&2 <<END
  60 Usage: $0 < msg
  61
  62 This script calls mutt, jumping to the message given in stdin.
  63 Uses a mail search engine (currently mairix, mu and nmzmail are supported),
  64 which has to be configured through MUTTJUMP_INDEXER variable.
  65 END
  66     exit 1
  67 fi
  68
  69 # check if mutt is installed
  70 if ! type -p $MUTT >/dev/null ; then
  71     die "$MUTT is not in PATH, set MUTT variable"
  72 fi
  73
  74 case $MUTTJUMP_MODE in
  75     limit|search)
  76         ;;
  77     *)
  78         die "variable MUTTJUMP_MODE must be set to \"limit\" or \"search\""
  79         ;;
  80 esac
  81
  82 # search for Message-ID in STDIN
  83 if type -p $FORMAIL >/dev/null ; then
  84     msgid=$($FORMAIL -c -z -x Message-ID | head -n1)
  85 elif type -p $REFORMAIL >/dev/null ; then
  86     msgid=$($REFORMAIL -c -x Message-ID: | head -n1)
  87 else
  88     msgid=$(sed -n 's/^Message-ID: \(.*\)/\1/Ip' | head -n1)
  89 fi
  90 if [ -z "$msgid" ] ; then
  91     die "could not find Message-ID header in standard input"
  92 fi
  93 msgid_clean=$(echo "$msgid" | sed 's/^<\(.*\)>$/\1/')
  94
  95 # try to locate path of message using a mail search engine
  96 case $MUTTJUMP_INDEXER in
  97     mairix)
  98         orig_msgfile=$($MAIRIX -r "m:$msgid_clean" | head -n1)
  99         ;;
 100     mu)
 101         orig_msgfile=$($MU find -f l "i:$msgid_clean" |
 102             grep -v "^\*\*" | head -n1)
 103         ;;
 104     mu-old)
 105         orig_msgfile=$($MU find -f p "m:$msgid_clean" | head -n1)
 106         ;;
 107     nmzmail)
 108         nmzmail_results=$(mktemp -d)
 109         echo "+message-id:$msgid" | $NMZMAIL -n 1 -r "$nmzmail_results"
 110         msgfile=$(find "$nmzmail_results" -type l | head -n1)
 111         orig_msgfile=$(readlink "$msgfile")
 112         rm -rf "$nmzmail_results"
 113         ;;
 114     "")
 115         die "variable MUTTJUMP_INDEXER not set or empty"
 116         ;;
 117     *)
 118         die "unknown mail index program \"$MUTTJUMP_INDEXER\""
 119         ;;
 120 esac
 121
 122 if [ -z "$orig_msgfile" -o ! -e "$orig_msgfile" ] ; then
 123     die "no message with msgid $msgid found!"
 124 fi
 125
 126 # get containing maildir of $orig_msgfile
 127 orig_maildir=$(dirname $(dirname "$orig_msgfile"))
 128 if [ ! -d "$orig_maildir/cur" ] ; then
 129     die "directory \"$orig_maildir\" doesn't exist or is no Maildir"
 130 fi
 131
 132 jump_cmd="<change-folder>$orig_maildir<enter><$MUTTJUMP_MODE>~i '$msgid'<enter>"
 133
 134 if [ "$MUTTJUMP_USE_SCREEN" = no ] ; then
 135
 136     # Close message-stdin and open terminal-stdin instead.
 137     # mutt behaves different if STDIN is no terminal
 138     # TODO: Find cleaner solution (e.g. mutt command-line argument?)
 139     exec 0<&-
 140     term="/dev/$(ps -p$$ --no-heading | awk '{print $2}')"
 141     exec < $term
 142
 143     # start mutt, open original folder and jump to the original message
 144     $MUTT -e "push \"$jump_cmd\""
 145
 146 else
 147
 148     screen_window_name=$(MUTTJUMP_SCREEN_WINDOW_NAME_MANGLE "$orig_maildir")
 149     screen_opts=""
 150     if [ -n "$MUTTJUMP_SCREEN_SESSION" ] ; then
 151         screen_opts="-S $MUTTJUMP_SCREEN_SESSION"
 152     fi
 153
 154     $SCREEN $screen_opts -X eval "select $screen_window_name" "stuff \":push \\\"$jump_cmd\\\"
 155 \""
 156     if [ $? != 0 ] ; then
 157         die "You have to manually start a screen session with:
 158 $SCREEN $screen_opts -t $screen_window_name $MUTT -f \"$orig_maildir\""
 159     fi
 160 fi