]> git.cworth.org Git - notmuch-wiki/blob - emacstips.mdwn
emacstips: invoking the external html viewer
[notmuch-wiki] / emacstips.mdwn
1 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
2 # Tips and Tricks for using notmuch with Emacs
3
4 One of the more popular notmuch message reading clients is
5 **notmuch.el**, an [emacs](http://www.gnu.org/software/emacs/) major
6 mode for interacting with notmuch.  It is included in the notmuch
7 package (notmuch-emacs in Debian).  This page goes over some usage
8 tips for using notmuch with Emacs.
9
10 [[!toc levels=2]]
11
12 ## Setup
13
14 Have a look at the [Howto](http://notmuchmail.org/howto/) for
15 prerequisites.  Be sure you have done the general setup using the
16 notmuch cli command!
17
18 To use the Notmuch emacs mode, first add the following line to your
19 `.emacs` rc file:
20
21         (autoload 'notmuch "notmuch" "notmuch mail" t)
22
23 or if you always want to load notmuch when you start emacs:
24
25         (require 'notmuch)
26
27 Then, either run "emacs -f notmuch", or execute the command `M-x
28 notmuch` from within a running emacs.
29
30 ### <span id="notmuch_init_file"> Notmuch Emacs configuration file: </span>
31
32 (Since Notmuch 0.18)
33
34 After notmuch is loaded `notmuch-init-file` (typically
35  `~/.emacs.d/notmuch-config.el`) is checked out. If such file exists
36 it is loaded. Most emacs lisp based configuration not suitable via
37 customization can be put there instead of `~/.emacs`.
38
39 ## Navigating & reading mails
40
41 When first starting notmuch in emacs, you will be presented with the
42 notmuch "hello" page.  If it exits with an error after writing
43 "Welcome to notmutch. You have" you need to do the basic notmuch setup
44 first (see above).
45 From here you can do searches, see lists of recent
46 searches, saved searches, message tags, help information, etc.
47
48 Executing a search will open a new buffer in `notmuch-search-mode`
49 displaying the search results.  Each line in the search results
50 represents a message thread.  Hitting the '?' key will show help for
51 this mode.
52
53 In general, the 'q' will kill the current notmuch buffer and return
54 you to the previous buffer (sort of like a 'pop').
55
56 In search mode, navigating to a thread and hitting return will then
57 open a new buffer in `notmuch-show-mode`, which will show the actual
58 message contents of the thread.
59
60 ## Sending mail
61
62 In any notmuch mode, you can start a new message by hitting the 'm'
63 key.  To reply to a message or thread, just hit the 'r' key.
64
65 When composing new messages, you will be entered in emacs's
66 `message-mode`, which is a powerful mode for composing and sending
67 messages.  When in message mode, you can type `C-c ?` for help.
68
69 If you would like to use address autocompletion when composing
70 messages, see [address completion](#address_completion).
71
72 When you are ready to send a message, type `C-c C-c`. By default
73 message mode will use your sendmail command to send mail, so make sure
74 that works. One annoying standard configuration of message mode is
75 that it will hide the sent mail in your emacs frame stack, but it will
76 not close it. If you type several mails in an emacs session they will
77 accumulate and make switching between buffers more annoying. You can
78 avoid that behavior by adding `(setq message-kill-buffer-on-exit t)`
79 in your `.emacs` file
80 (or doing `M-x customize-variable<RET>message-kill-buffer-on-exit<RET>`)
81 which will really close the mail window after sending it.
82
83 ## Attaching files
84
85 Using the `M-x mml-attach-file` command, you can attach any file to be
86 sent with your mail. By default this command is bound to the menu item
87 *Attachments--Attach File* with the key binding `C-c C-a`. The
88 variable `mml-dnd-attach-options` (`M-x
89 customize-variable<RET>mml-dnd-attach-options<RET>`) can be set to
90 allow the prompting for various attachment options (such as
91 inline/attachment) if you want to do that.
92
93 For those who prefer a more graphical interface, you can also simply
94 drag and drop files from a file manager into a mail composition window
95 to have them attached. In Ubuntu this works without any modifications
96 if files are dragged from the file manager.
97
98 And for those who prefer working from command line, the following
99 script opens new emacs window with empty message and attaches files
100 mentioned as script arguments. (Note: The script expects that you have
101 `(server-start)` in your `.emacs` file.)
102
103         #!/bin/sh
104         attach_cmds=""
105         while [ $# -gt 0 ]; do
106             fullpath=$(readlink --canonicalize "$1")
107             attach_cmds="$attach_cmds (mml-attach-file \"$fullpath\")"
108             shift
109         done
110         emacsclient -a '' -c -e "(progn (compose-mail) $attach_cmds)"
111
112 ## Controlling external handlers for attachements
113
114 You can choose e.g. which pdf viewer to invoke from notmuch-show mode by
115 adding a .mailcap file in your home directory. Here is an example:
116
117     application/pdf; /usr/bin/mupdf %s; test=test "$DISPLAY" != ""; description=Portable Document Format; nametemplate=%s.pdf
118     application/x-pdf; /usr/bin/mupdf %s; test=test "$DISPLAY" != ""; description=Portable Document Format; nametemplate=%s.pdf
119
120 ## Issues with Emacs 24
121
122 If notmuch-show-mode behaves badly for you in emacs 24.x try adding one of
123
124         (setq gnus-inhibit-images nil)
125
126 or
127
128         (require 'gnus-art)
129
130 to your .emacs file.
131
132 -----
133
134 # Advanced tips and tweaks
135
136 ## Initial cursor position in notmuch 0.15 hello window
137
138 In notmuch version 0.15 emacs client the handling of cursor position in
139 notmuch hello window has been simplified to a version which suits best
140 most cases.
141
142 Initially the cursor is positioned at the beginning of buffer.
143
144 Some users liked the "ancient" version where cursor was moved to the
145 first `Saved searches` button.
146
147 Add the following code to your notmuch emacs configuration file in
148 case you want this behaviour:
149
150         (add-hook 'notmuch-hello-refresh-hook
151                   (lambda ()
152                     (if (and (eq (point) (point-min))
153                              (search-forward "Saved searches:" nil t))
154                         (progn
155                           (forward-line)
156                           (widget-forward 1))
157                       (if (eq (widget-type (widget-at)) 'editable-field)
158                           (beginning-of-line)))))
159
160 ## Add a key binding to add/remove/toggle a tag
161
162 The `notmuch-{search,show,tree}-tag` functions are very useful for
163 making quick tag key bindings.  The arguments to these functions have
164 changed as notmuch has evolved but the following should work on all
165 versions of notmuch from 0.13 on.  These functions take a list of
166 tag changes as argument. For example, an argument of (list "+spam"
167 "-inbox") adds the tag spam and deletes the tag inbox. Note the
168 argument must be a list even if there is only a single tag change
169 e.g., use (list "+deleted") to add the deleted tag.
170
171 For instance, here's an example of how to make a key binding to add
172 the "spam" tag and remove the "inbox" tag in notmuch-show-mode:
173
174         (define-key notmuch-show-mode-map "S"
175           (lambda ()
176             "mark message as spam"
177             (interactive)
178             (notmuch-show-tag (list "+spam" "-inbox"))))
179
180 You can do the same for threads in `notmuch-search-mode` by just
181 replacing "show" with "search" in the keymap and called functions, or
182 for messages in `notmuch-tree-mode` by replacing "show" by "tree". If
183 you want to tag a whole thread in `notmuch-tree-mode` use
184 `notmuch-tree-tag-thread` instead of `notmuch-tree-tag`.
185
186 You may also want the function in search mode apply to the all threads
187 in the selected region (if there is one). For notmuch prior to 0.17
188 this behaviour will occur automatically with the functions given
189 above. To get this behaviour on 0.17+ do the following:
190
191         (define-key notmuch-search-mode-map "S"
192           (lambda (&optional beg end)
193             "mark thread as spam"
194             (interactive (notmuch-search-interactive-region))
195             (notmuch-search-tag (list "+spam" "-inbox") beg end)))
196
197 The analogous functionality in notmuch-tree is currently missing.
198
199 The definitions above make use of a lambda function, but you could
200 also define a separate function first:
201
202         (defun notmuch-show-tag-spam ()
203           "mark message as spam"
204           (interactive)
205           (notmuch-show-add-tag (list "+spam" "-inbox")))
206
207         (define-key notmuch-show-mode-map "S" 'notmuch-show-tag-spam)
208
209 Here's a more complicated example of how to add a toggle "deleted"
210 key:
211
212         (define-key notmuch-show-mode-map "d"
213           (lambda ()
214             "toggle deleted tag for message"
215             (interactive)
216             (if (member "deleted" (notmuch-show-get-tags))
217                 (notmuch-show-tag (list "-deleted"))
218               (notmuch-show-tag (list "+deleted")))))
219
220 ## Adding many tagging keybindings
221
222 If you want to have have many tagging keybindings, you can save the typing
223 the few lines of  boilerplate for every binding (for versions before 0.12,
224 you will need to change notmuch-show-apply-tag-macro).
225
226     (eval-after-load 'notmuch-show
227       '(define-key notmuch-show-mode-map "`" 'notmuch-show-apply-tag-macro))
228
229     (setq notmuch-show-tag-macro-alist
230       (list
231        '("m" "+notmuch::patch" "+notmuch::moreinfo" "-notmuch::needs-review")
232        '("n" "+notmuch::patch" "+notmuch::needs-review" "-notmuch::pushed")
233        '("o" "+notmuch::patch" "+notmuch::obsolete"
234              "-notmuch::needs-review" "-notmuch::moreinfo")
235        '("p" "-notmuch::pushed" "-notmuch::needs-review"
236          "-notmuch::moreinfo" "+pending")
237        '("P" "-pending" "-notmuch::needs-review" "-notmuch::moreinfo" "+notmuch::pushed")
238        '("r" "-notmuch::patch" "+notmuch::review")
239        '("s" "+notmuch::patch" "-notmuch::obsolete" "-notmuch::needs-review" "-notmuch::moreinfo" "+notmuch::stale")
240        '("t" "+notmuch::patch" "-notmuch::needs-review" "+notmuch::trivial")
241        '("w" "+notmuch::patch" "+notmuch::wip" "-notmuch::needs-review")))
242
243     (defun notmuch-show-apply-tag-macro (key)
244       (interactive "k")
245       (let ((macro (assoc key notmuch-show-tag-macro-alist)))
246         (apply 'notmuch-show-tag-message (cdr macro))))
247
248 ## Restore reply-to-all key binding to 'r'
249
250 Starting from notmuch 0.12 the 'r' key is bound to reply-to-sender instead of
251 reply-to-all. Here's how to swap the reply to sender/all bindings in show mode:
252
253         (define-key notmuch-show-mode-map "r" 'notmuch-show-reply)
254         (define-key notmuch-show-mode-map "R" 'notmuch-show-reply-sender)
255
256 And in search mode:
257
258         (define-key notmuch-search-mode-map "r" 'notmuch-search-reply-to-thread)
259         (define-key notmuch-search-mode-map "R" 'notmuch-search-reply-to-thread-sender)
260
261
262 ## How to do FCC/BCC...
263
264 The Emacs interface to notmuch will automatically add an `Fcc`
265 header to your outgoing mail so that any messages you send will also
266 be saved in your mail store. You can control where this copy of the
267 message is saved by setting the variable `notmuch-fcc-dirs` which defines the
268 subdirectory relative to the `database.path` setting from your
269 notmuch configuration in which to save the mail. Enter a directory
270 (without the maildir `/cur` ending which will be appended
271 automatically). Additional information can be found as usual using:
272
273        M-x describe-variable notmuch-fcc-dirs
274
275 An additional variable that can affect FCC settings in some cases is
276 `message-directory`. Emacs message-mode uses this variable for
277 postponed messages.
278
279 To customize both variables at the same time, use the fancy command:
280
281         M-x customize-apropos<RET>\(notmuch-fcc-dirs\)\|\(message-directory\)
282
283 This mechanism also allows you to select different folders to be
284 used for the outgoing mail depending on your selected `From`
285 address. Please see the documentation for the variable
286 `notmuch-fcc-dirs` in the customization window for how to arrange
287 this.
288
289 ## How to customize `notmuch-saved-searches`
290
291 When starting notmuch, a list of saved searches and message counts is
292 displayed, replacing the older `notmuch-folders` command. The set of
293 saved searches displayed can be modified directly from the notmuch
294 interface (using the `[save]` button next to a previous search) or by
295 customising the variable `notmuch-saved-searches`.
296
297 An example setting for notmuch versions up to 0.17.x might be:
298
299         (setq notmuch-saved-searches '(("inbox" . "tag:inbox")
300                         ("unread" . "tag:inbox AND tag:unread")
301                         ("notmuch" . "tag:inbox AND to:notmuchmail.org")))
302
303 Starting from notmuch 0.18 the variable changed. It is backwards
304 compatible so the above will still work but the new style will be used
305 if you use customize and there are some new features available. The above would become
306
307         (setq notmuch-saved-searches '((:name "inbox" :query "tag:inbox")
308                         (:name "unread" :query "tag:inbox AND tag:unread")
309                         (:name "notmuch" :query "tag:inbox AND to:notmuchmail.org")))
310
311 The additional features are the possibility to set the search order
312 for the search, and the possibility to specify a different query for
313 displaying the count for the saved-search. For example
314
315         (setq notmuch-saved-searches '((:name "inbox"
316                                         :query "tag:inbox"
317                                         :count-query "tag:inbox and tag:unread"
318                                         :sort-order 'oldest-first)))
319
320 specifies a single saved search for inbox, but the number displayed by
321 the search will be the number of unread messages in the inbox, and the
322 sort order for this search will be oldest-first.
323
324 Of course, you can have any number of saved searches, each configured
325 with any supported search terms (see "notmuch help search-terms"), and
326 in the new style variable they can each have different count-queries
327 and sort orders.
328
329 Some users find it useful to add `and not tag:delete` to those
330 searches, as they use the `delete` tag to mark messages as
331 deleted. This causes messages that are marked as deleted to be removed
332 from the commonly used views of messages.  Use whatever seems most
333 useful to you.
334
335 ## Viewing HTML messages with an external viewer
336
337 The Emacs client can generally display HTML messages inline using one of the
338 supported HTML renderers. This is controlled by the `mm-text-html-renderer`
339 variable.
340
341 Sometimes it may be necessary to display the message, or a single MIME part, in
342 an external browser. This can be done by `(notmuch-show-view-part)`, bound to
343 `. v` by default.
344
345 ## msmtp, message mode and multiple accounts
346
347 As an alternative to running a mail server such as sendmail or postfix
348 just to send email, it is possible to use
349 [msmtp](http://msmtp.sourceforge.net/). This small application will
350 look like `/usr/bin/sendmail` to a MUA such as emacs message mode, but
351 will just forward the email to an external SMTP server. It's fairly
352 easy to set up and it supports several accounts for using different
353 SMTP servers. The msmtp pages have several examples.
354
355 A typical scenario is that you want to use the company SMTP server
356 for email coming from your company email address, and your personal
357 server for personal email.  If msmtp is passed the envelope address
358 on the command line (the -f/--from option) it will automatically
359 pick the matching account.  The only trick here seems to be getting
360 emacs to actually pass the envelope from.  There are a number of
361 overlapping configuration variables that control this, and it's a
362 little confusion, but setting these three works for me:
363
364  - `mail-specify-envelope-from`: `t`
365
366  - `message-sendmail-envelope-from`: `header`
367
368  - `mail-envelope-from`: `header`
369
370 With that in place, you need a `.msmtprc` with the accounts configured
371 for the domains you want to send out using specific SMTP servers and
372 the rest will go to the default account.
373
374 If you have a hard time getting the above to work for you, as I did,
375 it's also possible to add a message-send-mail-hook in your .emacs to
376 send the from header explicitly as an argument to msmtp as described
377 [here](http://www.emacswiki.org/cgi-bin/wiki/GnusMSMTP#toc2) on the
378 emacswiki.
379
380
381 ## <span id="address_completion">Address completion when composing</span>
382
383 There are currently three solutions to this:
384
385 ### bbdb
386
387 [bbdb](http://bbdb.sourceforge.net) is a contact database for emacs
388 that works quite nicely together with message mode, including
389 address autocompletion.
390
391 ### notmuch database as an address book
392
393 You can also use the notmuch database as a mail address book itself.
394 To do this you need a command line tool that outputs likely address
395 candidates based on a search string.  There are currently four
396 available:
397
398   * The python tool `notmuch_address.py` (`git clone
399     http://commonmeasure.org/~jkr/git/notmuch_addresses.git`) (slower, but
400     no compilation required so good for testing the setup)
401
402   * The vala-based
403     [addrlookup](http://github.com/spaetz/vala-notmuch) (faster, but
404     needs compiling).  The addrlookup binary needs to be compiled.
405     Grab
406     `http://github.com/spaetz/vala-notmuch/raw/static-sources/src/addrlookup.c`
407     and build it with:
408
409             cc -o addrlookup addrlookup.c `pkg-config --cflags --libs gobject-2.0` -lnotmuch
410
411   * Shell/fgrep/perl combination [nottoomuch-addresses.sh](https://github.com/domo141/nottoomuch/blob/master/nottoomuch-addresses.rst).
412     This tools maintains it's own address "database" gathered from email
413     files notmuch knows and search from that "database" is done by `fgrep(1)`.
414
415   * python/sqlite combination [notmuch-abook](https://github.com/guyzmo/notmuch-abook/)
416     This tools also maintains an address database in sqlite after harvesting
417     from notmuch.  It also includes a vim plugin.
418
419 You can perform tab-completion using any of these programs.
420 Just add the following to your [notmuch init file](#notmuch_init_file):
421
422         (require 'notmuch-address)
423         (setq notmuch-address-command "/path/to/address_fetching_program")
424         (notmuch-address-message-insinuate)
425
426 ### Google Contacts
427
428 [GooBook](http://code.google.com/p/goobook/) is a command-line tool for
429 accessing Google Contacts. Install and set it up according to its documentation.
430
431 To use GooBook with notmuch, use this wrapper script and set it up like the
432 programs above.
433
434         #!/bin/sh
435         goobook query "$*" | sed 's/\(.*\)\t\(.*\)\t.*/\2 \<\1\>/' | sed '/^$/d'
436
437 You can add the sender of a message to Google Contacts by piping the message
438 (`notmuch-show-pipe-message`) to `goobook add`.
439
440 ### Akonadi
441
442         git clone https://github.com/mmehnert/akonadimailsearch
443
444 Install the development packages for kdepim on your system.
445 Enter the cloned repository and create a build directory:
446
447         mkdir build
448         cd build
449         cmake ..; make;
450
451 You will find the akonadimailsearch binary in the build/src directory. Copy it to ~/bin .
452
453 You can now add the following settings to your
454 [notmuch init file](#notmuch_init_file):
455
456         (require 'notmuch-address)
457         (setq notmuch-address-command "~/bin/akonadimailsearch")
458         (notmuch-address-message-insinuate)
459
460 ### Completion selection with helm
461
462 An address query might return multiple possible matches from which you
463 will have to select one. To ease this task, several different
464 frameworks in emacs support completion selection. One of them is
465 [helm](https://github.com/emacs-helm/helm). The following snippet
466 improves the out-of-the-box support for helm in notmuch as it enables
467 the required-match option and also does not ignore the first returned
468 address.
469
470         (setq notmuch-address-selection-function
471           (lambda (prompt collection initial-input)
472             (completing-read prompt (cons initial-input collection) nil t nil 'notmuch-address-history)))
473
474
475 ## How to sign/encrypt messages with gpg
476
477 Messages can by signed using gpg by invoking
478 `M-x mml-secure-sign-pgpmime` (or `M-x mml-secure-encrypt-pgpmime`).
479 These functions are available via the standard `message-mode` keybindings
480 `C-c C-m s p` and `C-c C-m c p`. To sign outgoing mail by default, use the
481 `message-setup-hook` in your `.emacs` file:
482
483         ;; Sign messages by default.
484         (add-hook 'message-setup-hook 'mml-secure-sign-pgpmime)
485
486 This inserts the required `<#part sign=pgpmime>` into the beginning
487 of the mail text body and will be converted into a pgp signature
488 when sending (so one can just manually delete that line if signing
489 is not required).
490
491 Alternatively, you may prefer to use `mml-secure-message-sign-pgpmime` instead
492 of `mml-secure-sign-pgpmime` to sign the whole message instead of just one
493 part.
494
495 ### Troubleshooting message-mode gpg support
496
497 - If you have trouble with expired subkeys, you may have encountered
498   emacs bug #7931.  This is fixed in git commit 301ea744c on
499   2011-02-02.  Note that if you have the Debian package easypg
500   installed, it will shadow the fixed version of easypg included with
501   emacs.
502
503 ## Reading and verifying encrypted and signed messages
504
505 Encrypted and signed mime messages can be read and verified with:
506
507         (notmuch-crypto-process-mime t)
508
509 Decrypting or verifying inline pgp messages can be done by selecting
510 an the inline pgp area and and using:
511
512         M-x epa-decrypt-region RET
513
514 ## Multiple identities using gnus-alias
515
516 [gnus-alias](http://www.emacswiki.org/emacs/GnusAlias) allows you to
517 define multiple identities when using `message-mode`. You can specify
518 the from address, organization, extra headers (including *Bcc*), extra
519 body text, and signature for each identity. Identities are chosen
520 based on a set of rules. When you are in message mode, you can switch
521 identities using gnus-alias.
522
523 ### Installation
524
525 - put `gnus-alias.el` on your load Emacs-Lisp load path (add new directory
526   to load path by writing `(add-to-list 'load-path "/some/load/path")` into
527   your `.emacs`.
528
529 - Add the following to your `.emacs`
530
531         (autoload 'gnus-alias-determine-identity "gnus-alias" "" t)
532         (add-hook 'message-setup-hook 'gnus-alias-determine-identity)
533
534 Looking into `gnus-alias.el` gives a bit more information...
535
536 ### Example Configuration
537
538 Here is an example configuration.
539
540         ;; Define two identities, "home" and "work"
541         (setq gnus-alias-identity-alist
542               '(("home"
543                  nil ;; Does not refer to any other identity
544                  "John Doe <jdoe@example.net>" ;; Sender address
545                  nil ;; No organization header
546                  nil ;; No extra headers
547                  nil ;; No extra body text
548                  "~/.signature")
549                 ("work"
550                  nil
551                  "John Doe <john.doe@example.com>"
552                  "Example Corp."
553                  (("Bcc" . "john.doe@example.com"))
554                  nil
555                  "~/.signature.work")))
556         ;; Use "home" identity by default
557         (setq gnus-alias-default-identity "home")
558         ;; Define rules to match work identity
559         (setq gnus-alias-identity-rules)
560               '(("work" ("any" "john.doe@\\(example\\.com\\|help\\.example.com\\)" both) "work"))
561         ;; Determine identity when message-mode loads
562         (add-hook 'message-setup-hook 'gnus-alias-determine-identity)
563
564 When `gnus-alias` has been loaded (using autoload, require, *M-x load-library*
565 or *M-x load-file* (load-file takes file path -- therefore it can be used
566 without any `.emacs` changes)) the following commands can be used to get(/set)
567 more information (some of these have "extensive documentation"):
568
569         M-x describe-variable RET gnus-alias-identity-alist
570         M-x describe-variable RET gnus-alias-identity-rules
571         M-x describe-variable RET gnus-alias-default-identity
572
573         M-x customize-group RET gnus-alias RET
574           or
575         M-x gnus-alias-customize RET
576
577 The last two do the same thing.
578
579 See also the **Usage:** section in `gnus-alias.el`.
580
581 ## Resending (or bouncing) messages
582
583 Add the following to your [notmuch init file](#notmuch_init_file) to be able
584 to resend the current message in show mode.
585
586         (define-key notmuch-show-mode-map "b"
587           (lambda (&optional address)
588             "Bounce the current message."
589             (interactive "sBounce To: ")
590             (notmuch-show-view-raw-message)
591             (message-resend address)))
592
593 ## `notmuch-hello` refresh status message
594
595 Add the following to your [notmuch init file](#notmuch_init_file) to get a
596 status message about the change in the number of messages in the mail store
597 when refreshing the `notmuch-hello` buffer.
598
599         (defvar notmuch-hello-refresh-count 0)
600
601         (defun notmuch-hello-refresh-status-message ()
602           (unless no-display
603             (let* ((new-count
604                     (string-to-number
605                      (car (process-lines notmuch-command "count"))))
606                    (diff-count (- new-count notmuch-hello-refresh-count)))
607               (cond
608                ((= notmuch-hello-refresh-count 0)
609                 (message "You have %s messages."
610                          (notmuch-hello-nice-number new-count)))
611                ((> diff-count 0)
612                 (message "You have %s more messages since last refresh."
613                          (notmuch-hello-nice-number diff-count)))
614                ((< diff-count 0)
615                 (message "You have %s fewer messages since last refresh."
616                          (notmuch-hello-nice-number (- diff-count)))))
617               (setq notmuch-hello-refresh-count new-count))))
618
619         (add-hook 'notmuch-hello-refresh-hook 'notmuch-hello-refresh-status-message)
620
621 ## Replacing tabs with spaces in subject and header
622
623 Mailman mailing list software rewrites and rewraps long message subjects in
624 a way that causes TABs to appear in the middle of the subject and header
625 lines. Add this to your [notmuch init file](#notmuch_init_file) to replace
626 tabs with spaces in subject lines:
627
628         (defun notmuch-show-subject-tabs-to-spaces ()
629           "Replace tabs with spaces in subject line."
630           (goto-char (point-min))
631           (when (re-search-forward "^Subject:" nil t)
632             (while (re-search-forward "\t" (line-end-position) t)
633               (replace-match " " nil nil))))
634
635         (add-hook 'notmuch-show-markup-headers-hook 'notmuch-show-subject-tabs-to-spaces)
636
637 And in header lines (this will only work with the yet to be released
638 notmuch version 0.15):
639
640         (defun notmuch-show-header-tabs-to-spaces ()
641           "Replace tabs with spaces in header line."
642           (setq header-line-format
643                 (notmuch-show-strip-re
644                  (replace-regexp-in-string "\t" " " (notmuch-show-get-subject)))))
645
646         (add-hook 'notmuch-show-hook 'notmuch-show-header-tabs-to-spaces)
647
648 ## Hiding unread messages in notmuch-show
649
650 I like to have an inbox saved search, but only show unread messages when they
651 view a thread. This takes two steps:
652
653 1. Apply
654 [this patch from Mark Walters](http://notmuchmail.org/pipermail/notmuch/2012/010817.html)
655 to add the `notmuch-show-filter-thread` function.
656 1. Add the following hook to your emacs configuration:
657
658         (defun expand-only-unread-hook () (interactive)
659           (let ((unread nil)
660                 (open (notmuch-show-get-message-ids-for-open-messages)))
661             (notmuch-show-mapc (lambda ()
662                                  (when (member "unread" (notmuch-show-get-tags))
663                                    (setq unread t))))
664             (when unread
665               (let ((notmuch-show-hook (remove 'expand-only-unread-hook notmuch-show-hook)))
666                 (notmuch-show-filter-thread "tag:unread")))))
667
668         (add-hook 'notmuch-show-hook 'expand-only-unread-hook)
669
670 ## Changing the color of a saved search based on some other search
671
672 I like to have a saved search for my inbox, but have it change color when there
673 are thread with unread messages in the inbox. I accomplish this with the
674 following code in my emacs config:
675
676         (defun color-inbox-if-unread () (interactive)
677           (save-excursion
678             (goto-char (point-min))
679             (let ((cnt (car (process-lines "notmuch" "count" "tag:inbox and tag:unread"))))
680               (when (> (string-to-number cnt) 0)
681                 (save-excursion
682                   (when (search-forward "inbox" (point-max) t)
683                     (let* ((overlays (overlays-in (match-beginning 0) (match-end 0)))
684                            (overlay (car overlays)))
685                       (when overlay
686                         (overlay-put overlay 'face '((:inherit bold) (:foreground "green")))))))))))
687         (add-hook 'notmuch-hello-refresh-hook 'color-inbox-if-unread)
688
689 ## Linking to notmuch messages and threads from the Circe IRC client
690
691 [Circe](https://github.com/jorgenschaefer/circe/wiki) is an IRC client for emacs.
692 To have clickable buttons for notmuch messages and threads, add the following to
693 `lui-buttons-list` (using, e.g. M-x customize-variable)
694
695     ("\\(?:id\\|mid\\|thread\\):[0-9A-Za-z][0-9A-Za-z.@-]*" 0 notmuch-show 0)
696
697 If you have notmuch-pick installed, it works fine for this as well.
698
699 ## Linking to notmuch messages from org-mode
700
701 Support for linking to notmuch messages is distributed with org-mode,
702 but as a contrib file, so you might have to work a bit to load it.
703
704 In Debian and derivatives,
705
706     (add-to-list 'load-path "/usr/share/org-mode/lisp")
707
708 Then
709
710     (require 'org-notmuch)
711
712 In general it is nice to have a key for org-links (not just for notmuch). For example
713
714     (define-key global-map "\C-cl" 'org-store-link)
715
716 ## Viewing diffs in notmuch
717
718 The following code allows you to view an inline patch in diff-mode
719 directly from notmuch. This means that normal diff-mode commands like
720 refine, next hunk etc all work.
721
722     (defun my-notmuch-show-view-as-patch ()
723       "View the the current message as a patch."
724       (interactive)
725       (let* ((id (notmuch-show-get-message-id))
726              (subject (concat "Subject: " (notmuch-show-get-subject) "\n"))
727              (diff-default-read-only t)
728              (buf (get-buffer-create (concat "*notmuch-patch-" id "*")))
729              (map (make-sparse-keymap)))
730         (define-key map "q" 'notmuch-kill-this-buffer)
731         (switch-to-buffer buf)
732         (let ((inhibit-read-only t))
733           (erase-buffer)
734           (insert subject)
735           (insert (notmuch-get-bodypart-internal id 1 nil)))
736         (set-buffer-modified-p nil)
737         (diff-mode)
738         (lexical-let ((new-ro-bind (cons 'buffer-read-only map)))
739                      (add-to-list 'minor-mode-overriding-map-alist new-ro-bind))
740         (goto-char (point-min))))
741
742 and then this function needs to bound into the keymap with something like
743
744     (define-key 'notmuch-show-mode-map "D" 'my-notmuch-show-view-as-patch)