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

Benjamin Mako Hill || Want to submit a patch?