1 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
2 # Tips and Tricks for using Notmuch with Emacs
4 Here are some tips and tricks for using Notmuch with Emacs. See the [[Notmuch
5 Emacs Interface|notmuch-emacs]] page for basics.
9 ## Issues with Emacs 24
11 If notmuch-show-mode behaves badly for you in emacs 24.x try adding one of
13 (setq gnus-inhibit-images nil)
21 ## Controlling external handlers for attachements
23 You can choose e.g. which pdf viewer to invoke from notmuch-show mode by
24 adding a .mailcap file in your home directory. Here is an example:
26 application/pdf; /usr/bin/mupdf %s; test=test "$DISPLAY" != ""; description=Portable Document Format; nametemplate=%s.pdf
27 application/x-pdf; /usr/bin/mupdf %s; test=test "$DISPLAY" != ""; description=Portable Document Format; nametemplate=%s.pdf
29 ## Overwriting the sender address
31 If you want to always use the same sender address, then the following
32 defadvice can help you.
34 (defadvice notmuch-mua-reply (around notmuch-fix-sender)
35 (let ((sender "Max Monster <max.monster@example.com>"))
37 (ad-activate 'notmuch-mua-reply)
39 ## Initial cursor position in notmuch 0.15 hello window
41 In notmuch version 0.15 emacs client the handling of cursor position in
42 notmuch hello window has been simplified to a version which suits best
45 Initially the cursor is positioned at the beginning of buffer.
47 Some users liked the "ancient" version where cursor was moved to the
48 first `Saved searches` button.
50 Add the following code to your notmuch emacs configuration file in
51 case you want this behaviour:
53 (add-hook 'notmuch-hello-refresh-hook
55 (if (and (eq (point) (point-min))
56 (search-forward "Saved searches:" nil t))
60 (if (eq (widget-type (widget-at)) 'editable-field)
61 (beginning-of-line)))))
63 ## Add a key binding to add/remove/toggle a tag
65 The `notmuch-{search,show,tree}-tag` functions are very useful for
66 making quick tag key bindings. The arguments to these functions have
67 changed as notmuch has evolved but the following should work on all
68 versions of notmuch from 0.13 on. These functions take a list of
69 tag changes as argument. For example, an argument of (list "+spam"
70 "-inbox") adds the tag spam and deletes the tag inbox. Note the
71 argument must be a list even if there is only a single tag change
72 e.g., use (list "+deleted") to add the deleted tag.
74 For instance, here's an example of how to make a key binding to add
75 the "spam" tag and remove the "inbox" tag in notmuch-show-mode:
77 (define-key notmuch-show-mode-map "S"
79 "mark message as spam"
81 (notmuch-show-tag (list "+spam" "-inbox"))))
83 You can do the same for threads in `notmuch-search-mode` by just
84 replacing "show" with "search" in the keymap and called functions, or
85 for messages in `notmuch-tree-mode` by replacing "show" by "tree". If
86 you want to tag a whole thread in `notmuch-tree-mode` use
87 `notmuch-tree-tag-thread` instead of `notmuch-tree-tag`.
89 You may also want the function in search mode apply to the all threads
90 in the selected region (if there is one). For notmuch prior to 0.17
91 this behaviour will occur automatically with the functions given
92 above. To get this behaviour on 0.17+ do the following:
94 (define-key notmuch-search-mode-map "S"
95 (lambda (&optional beg end)
97 (interactive (notmuch-search-interactive-region))
98 (notmuch-search-tag (list "+spam" "-inbox") beg end)))
100 The analogous functionality in notmuch-tree is currently missing.
102 The definitions above make use of a lambda function, but you could
103 also define a separate function first:
105 (defun notmuch-show-tag-spam ()
106 "mark message as spam"
108 (notmuch-show-add-tag (list "+spam" "-inbox")))
110 (define-key notmuch-show-mode-map "S" 'notmuch-show-tag-spam)
112 Here's a more complicated example of how to add a toggle "deleted"
115 (define-key notmuch-show-mode-map "d"
117 "toggle deleted tag for message"
119 (if (member "deleted" (notmuch-show-get-tags))
120 (notmuch-show-tag (list "-deleted"))
121 (notmuch-show-tag (list "+deleted")))))
123 ## Adding many tagging keybindings
125 If you want to have have many tagging keybindings, you can save the typing
126 the few lines of boilerplate for every binding (for versions before 0.12,
127 you will need to change notmuch-show-apply-tag-macro).
129 (eval-after-load 'notmuch-show
130 '(define-key notmuch-show-mode-map "`" 'notmuch-show-apply-tag-macro))
132 (setq notmuch-show-tag-macro-alist
134 '("m" "+notmuch::patch" "+notmuch::moreinfo" "-notmuch::needs-review")
135 '("n" "+notmuch::patch" "+notmuch::needs-review" "-notmuch::pushed")
136 '("o" "+notmuch::patch" "+notmuch::obsolete"
137 "-notmuch::needs-review" "-notmuch::moreinfo")
138 '("p" "-notmuch::pushed" "-notmuch::needs-review"
139 "-notmuch::moreinfo" "+pending")
140 '("P" "-pending" "-notmuch::needs-review" "-notmuch::moreinfo" "+notmuch::pushed")
141 '("r" "-notmuch::patch" "+notmuch::review")
142 '("s" "+notmuch::patch" "-notmuch::obsolete" "-notmuch::needs-review" "-notmuch::moreinfo" "+notmuch::stale")
143 '("t" "+notmuch::patch" "-notmuch::needs-review" "+notmuch::trivial")
144 '("w" "+notmuch::patch" "+notmuch::wip" "-notmuch::needs-review")))
146 (defun notmuch-show-apply-tag-macro (key)
148 (let ((macro (assoc key notmuch-show-tag-macro-alist)))
149 (apply 'notmuch-show-tag-message (cdr macro))))
151 ## Restore reply-to-all key binding to 'r'
153 Starting from notmuch 0.12 the 'r' key is bound to reply-to-sender instead of
154 reply-to-all. Here's how to swap the reply to sender/all bindings in show mode:
156 (define-key notmuch-show-mode-map "r" 'notmuch-show-reply)
157 (define-key notmuch-show-mode-map "R" 'notmuch-show-reply-sender)
161 (define-key notmuch-search-mode-map "r" 'notmuch-search-reply-to-thread)
162 (define-key notmuch-search-mode-map "R" 'notmuch-search-reply-to-thread-sender)
165 ## How to do FCC/BCC...
167 The Emacs interface to notmuch will automatically add an `Fcc`
168 header to your outgoing mail so that any messages you send will also
169 be saved in your mail store. You can control where this copy of the
170 message is saved by setting the variable `notmuch-fcc-dirs` which defines the
171 subdirectory relative to the `database.path` setting from your
172 notmuch configuration in which to save the mail. Enter a directory
173 (without the maildir `/cur` ending which will be appended
174 automatically). Additional information can be found as usual using:
176 M-x describe-variable notmuch-fcc-dirs
178 An additional variable that can affect FCC settings in some cases is
179 `message-directory`. Emacs message-mode uses this variable for
182 To customize both variables at the same time, use the fancy command:
184 M-x customize-apropos<RET>\(notmuch-fcc-dirs\)\|\(message-directory\)
186 This mechanism also allows you to select different folders to be
187 used for the outgoing mail depending on your selected `From`
188 address. Please see the documentation for the variable
189 `notmuch-fcc-dirs` in the customization window for how to arrange
192 ## How to customize `notmuch-saved-searches`
194 When starting notmuch, a list of saved searches and message counts is
195 displayed, replacing the older `notmuch-folders` command. The set of
196 saved searches displayed can be modified directly from the notmuch
197 interface (using the `[save]` button next to a previous search) or by
198 customising the variable `notmuch-saved-searches`.
200 An example setting for notmuch versions up to 0.17.x might be:
202 (setq notmuch-saved-searches '(("inbox" . "tag:inbox")
203 ("unread" . "tag:inbox AND tag:unread")
204 ("notmuch" . "tag:inbox AND to:notmuchmail.org")))
206 Starting from notmuch 0.18 the variable changed. It is backwards
207 compatible so the above will still work but the new style will be used
208 if you use customize and there are some new features available. The above would become
210 (setq notmuch-saved-searches '((:name "inbox" :query "tag:inbox")
211 (:name "unread" :query "tag:inbox AND tag:unread")
212 (:name "notmuch" :query "tag:inbox AND to:notmuchmail.org")))
214 The additional features are the possibility to set the search order
215 for the search, and the possibility to specify a different query for
216 displaying the count for the saved-search. For example
218 (setq notmuch-saved-searches '((:name "inbox"
220 :count-query "tag:inbox and tag:unread"
221 :sort-order oldest-first)))
223 specifies a single saved search for inbox, but the number displayed by
224 the search will be the number of unread messages in the inbox, and the
225 sort order for this search will be oldest-first.
227 Of course, you can have any number of saved searches, each configured
228 with any supported search terms (see "notmuch help search-terms"), and
229 in the new style variable they can each have different count-queries
232 Some users find it useful to add `and not tag:delete` to those
233 searches, as they use the `delete` tag to mark messages as
234 deleted. This causes messages that are marked as deleted to be removed
235 from the commonly used views of messages. Use whatever seems most
238 ## Viewing HTML messages with an external viewer
240 The Emacs client can generally display HTML messages inline using one of the
241 supported HTML renderers. This is controlled by the `mm-text-html-renderer`
244 Sometimes it may be necessary to display the message, or a single MIME part, in
245 an external browser. This can be done by `(notmuch-show-view-part)`, bound to
248 ## msmtp, message mode and multiple accounts
250 As an alternative to running a mail server such as sendmail or postfix
251 just to send email, it is possible to use
252 [msmtp](http://msmtp.sourceforge.net/). This small application will
253 look like `/usr/bin/sendmail` to a MUA such as emacs message mode, but
254 will just forward the email to an external SMTP server. It's fairly
255 easy to set up and it supports several accounts for using different
256 SMTP servers. The msmtp pages have several examples.
258 A typical scenario is that you want to use the company SMTP server
259 for email coming from your company email address, and your personal
260 server for personal email. If msmtp is passed the envelope address
261 on the command line (the -f/--from option) it will automatically
262 pick the matching account. The only trick here seems to be getting
263 emacs to actually pass the envelope from. There are a number of
264 overlapping configuration variables that control this, and it's a
265 little confusion, but setting these three works for me:
267 - `mail-specify-envelope-from`: `t`
269 - `message-sendmail-envelope-from`: `header`
271 - `mail-envelope-from`: `header`
273 With that in place, you need a `.msmtprc` with the accounts configured
274 for the domains you want to send out using specific SMTP servers and
275 the rest will go to the default account.
277 ## sending mail using smtpmail
279 <!-- By default message mode will use the system `sendmail` command to send
280 mail. However, on a typical desktop machine there may not be local SMTP
281 daemon running (nor it is configured to send mail outside of the system). -->
283 If setting up local `sendmail` or `msmtp` is not feasible or desirable,
284 the Emacs `smtpmail` package can be used to send email by talking to remote
285 SMTP server via TCP connection. It is pretty easy to configure:
287 1. Emacs variable `message-send-mail-function` has not been set
289 Initially, Emacs variable `message-send-mail-function` has value of
290 `sendmail-query-once`. When (notmuch) message mode is about to send email,
291 `sendmail-query-once` will ask how emacs should send email. Typing `smtp`
292 will configure `smtpmail` and Emacs may prompt for SMTP settings.
294 1. `M-x customize-group RET smtpmail`
296 As a minimum, 'Smtpmail Smtp Server' needs to be set.
298 After doing that, continue with `M-x load-library RET message` and
299 `M-x customize-variable RET message-send-mail-function`.
300 In the customization buffer select `message-smtpmail-send-it`.
302 1. Set some variables in .emacs or in [notmuch init file](/notmuch-emacs#notmuch_init_file)
304 (setq smtpmail-smtp-server "smtp.server.tld" ;; <-- edit this !!!
305 ;; smtpmail-smtp-service 25 ;; 25 is default -- uncomment and edit if needed
306 ;; smtpmail-stream-type 'starttls
307 ;; smtpmail-debug-info t
308 ;; smtpmail-debug-verb t
309 message-send-mail-function 'message-smtpmail-send-it)
311 Note that emacs 24 or newer is required for `smtpmail-stream-type`
312 (and smtp authentication) to be effective.
314 More information for smtpmail is available:
316 * In Emacs: `M-x info-display-manual smtpmail`
317 * [EmacsWiki Page](http://www.emacswiki.org/emacs/SendingMail)
320 ## <span id="address_completion">Address completion when composing</span>
322 There are currently three solutions to this:
326 Starting with Notmuch 0.21, there is a builtin command to perform
327 autocompletion directly within Notmuch. Starting with 0.22, it is
328 configured by default, so if you have previously configured another
329 completion mechanism, you may want to try out the new internal
330 method. Use `M-x customize-variable RET notmuch-address-command` and
331 reset the value to "internal address completion" (`'internal` in
334 If you are not yet running 0.22, you can still use it by adding a
335 wrapper around the command called, say, `notmuch-address`:
338 exec notmuch address from:"$*"
340 Then you can set the `notmuch-address-command` to `notmuch-address`
341 (if it is in your `$PATH` of course, otherwise use an absolute path).
345 [bbdb](http://bbdb.sourceforge.net) is a contact database for emacs
346 that works quite nicely together with message mode, including
347 address autocompletion.
349 ### notmuch database as an address book
351 You can also use the notmuch database as a mail address book itself.
352 To do this you need a command line tool that outputs likely address
353 candidates based on a search string. There are currently four
356 * The python tool `notmuch_address.py` (`git clone
357 http://commonmeasure.org/~jkr/git/notmuch_addresses.git`) (slower, but
358 no compilation required so good for testing the setup)
360 * The C-based [notmuch-addrlookup](https://github.com/aperezdc/notmuch-addrlookup-c) by [Adrian Perez](http://perezdecastro.org/), which is faster but needs to be compiled.
362 git clone https://github.com/aperezdc/notmuch-addrlookup-c
363 cd notmuch-addrlookup-c
367 [addrlookup](http://github.com/spaetz/vala-notmuch) The addrlookup binary needs to be compiled.
369 `http://github.com/spaetz/vala-notmuch/raw/static-sources/src/addrlookup.c`
372 cc -o addrlookup addrlookup.c `pkg-config --cflags --libs gobject-2.0` -lnotmuch
374 * Shell/fgrep/perl combination [nottoomuch-addresses.sh](https://github.com/domo141/nottoomuch/blob/master/nottoomuch-addresses.rst).
375 This tools maintains it's own address "database" gathered from email
376 files notmuch knows and search from that "database" is done by `fgrep(1)`.
378 * python/sqlite combination [notmuch-abook](https://github.com/guyzmo/notmuch-abook/)
379 This tools also maintains an address database in sqlite after harvesting
380 from notmuch. It also includes a vim plugin.
382 You can perform tab-completion using any of these programs.
383 Just add the following to your [notmuch init file](/notmuch-emacs#notmuch_init_file):
385 (require 'notmuch-address)
386 (setq notmuch-address-command "/path/to/address_fetching_program")
387 (notmuch-address-message-insinuate)
391 [GooBook](http://code.google.com/p/goobook/) is a command-line tool for
392 accessing Google Contacts. Install and set it up according to its documentation.
394 To use GooBook with notmuch, use this wrapper script and set it up like the
398 goobook query "$*" | sed 's/\(.*\)\t\(.*\)\t.*/\2 \<\1\>/' | sed '/^$/d'
400 You can add the sender of a message to Google Contacts by piping the message
401 (`notmuch-show-pipe-message`) to `goobook add`.
405 git clone https://github.com/mmehnert/akonadimailsearch
407 Install the development packages for kdepim on your system.
408 Enter the cloned repository and create a build directory:
414 You will find the akonadimailsearch binary in the build/src directory. Copy it to ~/bin .
416 You can now add the following settings to your
417 [notmuch init file](/notmuch-emacs#notmuch_init_file):
419 (require 'notmuch-address)
420 (setq notmuch-address-command "~/bin/akonadimailsearch")
421 (notmuch-address-message-insinuate)
423 ### Completion selection with helm
425 An address query might return multiple possible matches from which you
426 will have to select one. To ease this task, several different
427 frameworks in emacs support completion selection. One of them is
428 [helm](https://github.com/emacs-helm/helm). The following snippet
429 improves the out-of-the-box support for helm in notmuch as it enables
430 the required-match option and also does not ignore the first returned
433 (setq notmuch-address-selection-function
434 (lambda (prompt collection initial-input)
435 (completing-read prompt (cons initial-input collection) nil t nil 'notmuch-address-history)))
438 ## How to sign/encrypt messages with gpg
440 Messages can by signed using gpg by invoking
441 `M-x mml-secure-sign-pgpmime` (or `M-x mml-secure-encrypt-pgpmime`).
442 These functions are available via the standard `message-mode` keybindings
443 `C-c C-m s p` and `C-c C-m c p`. To sign outgoing mail by default, use the
444 `message-setup-hook` in your `.emacs` file:
446 ;; Sign messages by default.
447 (add-hook 'message-setup-hook 'mml-secure-sign-pgpmime)
449 This inserts the required `<#part sign=pgpmime>` into the beginning
450 of the mail text body and will be converted into a pgp signature
451 when sending (so one can just manually delete that line if signing
454 Alternatively, you may prefer to use `mml-secure-message-sign-pgpmime` instead
455 of `mml-secure-sign-pgpmime` to sign the whole message instead of just one
458 ### Troubleshooting message-mode gpg support
460 - If you have trouble with expired subkeys, you may have encountered
461 emacs bug #7931. This is fixed in git commit 301ea744c on
462 2011-02-02. Note that if you have the Debian package easypg
463 installed, it will shadow the fixed version of easypg included with
466 - If you wish `mml-secure-encrypt` to encrypt also for the sender, then
467 `M-x customize-variable mml2015-encrypt-to-self` might suit your need.
469 ## Reading and verifying encrypted and signed messages
471 Encrypted and signed mime messages can be read and verified with:
473 (setq notmuch-crypto-process-mime t)
475 Decrypting or verifying inline pgp messages can be done by selecting
476 an the inline pgp area and and using:
478 M-x epa-decrypt-region RET
480 ## Multiple identities using gnus-alias
482 [gnus-alias](http://www.emacswiki.org/emacs/GnusAlias) allows you to
483 define multiple identities when using `message-mode`. You can specify
484 the from address, organization, extra headers (including *Bcc*), extra
485 body text, and signature for each identity. Identities are chosen
486 based on a set of rules. When you are in message mode, you can switch
487 identities using gnus-alias.
491 - put `gnus-alias.el` on your load Emacs-Lisp load path (add new directory
492 to load path by writing `(add-to-list 'load-path "/some/load/path")` into
495 - Add the following to your `.emacs`
497 (autoload 'gnus-alias-determine-identity "gnus-alias" "" t)
498 (add-hook 'message-setup-hook 'gnus-alias-determine-identity)
500 Looking into `gnus-alias.el` gives a bit more information...
502 ### Example Configuration
504 Here is an example configuration.
506 ;; Define two identities, "home" and "work"
507 (setq gnus-alias-identity-alist
509 nil ;; Does not refer to any other identity
510 "John Doe <jdoe@example.net>" ;; Sender address
511 nil ;; No organization header
512 nil ;; No extra headers
513 nil ;; No extra body text
517 "John Doe <john.doe@example.com>"
519 (("Bcc" . "john.doe@example.com"))
521 "~/.signature.work")))
522 ;; Use "home" identity by default
523 (setq gnus-alias-default-identity "home")
524 ;; Define rules to match work identity
525 (setq gnus-alias-identity-rules)
526 '(("work" ("any" "john.doe@\\(example\\.com\\|help\\.example.com\\)" both) "work"))
527 ;; Determine identity when message-mode loads
528 (add-hook 'message-setup-hook 'gnus-alias-determine-identity)
530 When `gnus-alias` has been loaded (using autoload, require, *M-x load-library*
531 or *M-x load-file* (load-file takes file path -- therefore it can be used
532 without any `.emacs` changes)) the following commands can be used to get(/set)
533 more information (some of these have "extensive documentation"):
535 M-x describe-variable RET gnus-alias-identity-alist
536 M-x describe-variable RET gnus-alias-identity-rules
537 M-x describe-variable RET gnus-alias-default-identity
539 M-x customize-group RET gnus-alias RET
541 M-x gnus-alias-customize RET
543 The last two do the same thing.
545 See also the **Usage:** section in `gnus-alias.el`.
547 ## Multiple identities (and more) with message-templ
549 Another option for multiple identities is
550 [message-templ](http://pivot.cs.unb.ca/git?p=message-templ.git;a=summary)
551 (also a available in marmalade). This provides roughly the same
552 facilities as wanderlust's template facility.
555 [example.emacs.el](http://pivot.cs.unb.ca/git?p=message-templ.git;a=blob;f=example.emacs.el;hb=HEAD)
556 for some simple examples of usage.
558 ## Resending (or bouncing) messages
560 Add the following to your [notmuch init file](/notmuch-emacs#notmuch_init_file) to be able
561 to resend the current message in show mode.
563 (define-key notmuch-show-mode-map "b"
564 (lambda (&optional address)
565 "Bounce the current message."
566 (interactive "sBounce To: ")
567 (notmuch-show-view-raw-message)
568 (message-resend address)))
570 ## `notmuch-hello` refresh status message
572 Add the following to your [notmuch init file](/notmuch-emacs#notmuch_init_file) to get a
573 status message about the change in the number of messages in the mail store
574 when refreshing the `notmuch-hello` buffer.
576 (defvar notmuch-hello-refresh-count 0)
578 (defun notmuch-hello-refresh-status-message ()
582 (car (process-lines notmuch-command "count"))))
583 (diff-count (- new-count notmuch-hello-refresh-count)))
585 ((= notmuch-hello-refresh-count 0)
586 (message "You have %s messages."
587 (notmuch-hello-nice-number new-count)))
589 (message "You have %s more messages since last refresh."
590 (notmuch-hello-nice-number diff-count)))
592 (message "You have %s fewer messages since last refresh."
593 (notmuch-hello-nice-number (- diff-count)))))
594 (setq notmuch-hello-refresh-count new-count))))
596 (add-hook 'notmuch-hello-refresh-hook 'notmuch-hello-refresh-status-message)
598 ## Replacing tabs with spaces in subject and header
600 Mailman mailing list software rewrites and rewraps long message subjects in
601 a way that causes TABs to appear in the middle of the subject and header
602 lines. Add this to your [notmuch init file](/notmuch-emacs#notmuch_init_file) to replace
603 tabs with spaces in subject lines:
605 (defun notmuch-show-subject-tabs-to-spaces ()
606 "Replace tabs with spaces in subject line."
607 (goto-char (point-min))
608 (when (re-search-forward "^Subject:" nil t)
609 (while (re-search-forward "\t" (line-end-position) t)
610 (replace-match " " nil nil))))
612 (add-hook 'notmuch-show-markup-headers-hook 'notmuch-show-subject-tabs-to-spaces)
614 And in header lines (this will only work with the yet to be released
615 notmuch version 0.15):
617 (defun notmuch-show-header-tabs-to-spaces ()
618 "Replace tabs with spaces in header line."
619 (setq header-line-format
620 (notmuch-show-strip-re
621 (replace-regexp-in-string "\t" " " (notmuch-show-get-subject)))))
623 (add-hook 'notmuch-show-hook 'notmuch-show-header-tabs-to-spaces)
625 ## Hiding unread messages in notmuch-show
627 I like to have an inbox saved search, but only show unread messages when they
628 view a thread. This takes two steps:
631 [this patch from Mark Walters](https://notmuchmail.org/pipermail/notmuch/2012/010817.html)
632 to add the `notmuch-show-filter-thread` function.
633 1. Add the following hook to your emacs configuration:
635 (defun expand-only-unread-hook () (interactive)
637 (open (notmuch-show-get-message-ids-for-open-messages)))
638 (notmuch-show-mapc (lambda ()
639 (when (member "unread" (notmuch-show-get-tags))
642 (let ((notmuch-show-hook (remove 'expand-only-unread-hook notmuch-show-hook)))
643 (notmuch-show-filter-thread "tag:unread")))))
645 (add-hook 'notmuch-show-hook 'expand-only-unread-hook)
647 ## Changing the color of a saved search based on some other search
649 I like to have a saved search for my inbox, but have it change color when there
650 are thread with unread messages in the inbox. I accomplish this with the
651 following code in my emacs config:
653 (defun color-inbox-if-unread () (interactive)
655 (goto-char (point-min))
656 (let ((cnt (car (process-lines "notmuch" "count" "tag:inbox and tag:unread"))))
657 (when (> (string-to-number cnt) 0)
659 (when (search-forward "inbox" (point-max) t)
660 (let* ((overlays (overlays-in (match-beginning 0) (match-end 0)))
661 (overlay (car overlays)))
663 (overlay-put overlay 'face '((:inherit bold) (:foreground "green")))))))))))
664 (add-hook 'notmuch-hello-refresh-hook 'color-inbox-if-unread)
666 ## Linking to notmuch messages and threads from the Circe IRC client
668 [Circe](https://github.com/jorgenschaefer/circe/wiki) is an IRC client for emacs.
669 To have clickable buttons for notmuch messages and threads, add the following to
670 `lui-buttons-list` (using, e.g. M-x customize-variable)
672 ("\\(?:id\\|mid\\|thread\\):[0-9A-Za-z][0-9A-Za-z.@-]*" 0 notmuch-show 0)
674 If you have notmuch-pick installed, it works fine for this as well.
676 ## Linking to notmuch messages from org-mode
678 Support for linking to notmuch messages is distributed with org-mode,
679 but as a contrib file, so you might have to work a bit to load it.
681 In Debian and derivatives,
683 (add-to-list 'load-path "/usr/share/org-mode/lisp")
687 (require 'org-notmuch)
689 In general it is nice to have a key for org-links (not just for notmuch). For example
691 (define-key global-map "\C-cl" 'org-store-link)
693 ## Viewing diffs in notmuch
695 The following code allows you to view an inline patch in diff-mode
696 directly from notmuch. This means that normal diff-mode commands like
697 refine, next hunk etc all work.
699 (defun my-notmuch-show-view-as-patch ()
700 "View the the current message as a patch."
702 (let* ((id (notmuch-show-get-message-id))
703 (msg (notmuch-show-get-message-properties))
704 (part (notmuch-show-get-part-properties))
705 (subject (concat "Subject: " (notmuch-show-get-subject) "\n"))
706 (diff-default-read-only t)
707 (buf (get-buffer-create (concat "*notmuch-patch-" id "*")))
708 (map (make-sparse-keymap)))
709 (define-key map "q" 'notmuch-bury-or-kill-this-buffer)
710 (switch-to-buffer buf)
711 (let ((inhibit-read-only t))
714 (insert (notmuch-get-bodypart-text msg part nil)))
715 (set-buffer-modified-p nil)
717 (lexical-let ((new-ro-bind (cons 'buffer-read-only map)))
718 (add-to-list 'minor-mode-overriding-map-alist new-ro-bind))
719 (goto-char (point-min))))
721 and then this function needs to bound to `. d` in the keymap
723 (define-key 'notmuch-show-part-map "d" 'my-notmuch-show-view-as-patch)
725 ## Interfacing with Patchwork
727 [Patchwork](http://jk.ozlabs.org/projects/patchwork/) is a web-based system for
728 tracking patches sent to a mailing list. While the Notmuch project doesn't use
729 it, many other open source projects do. Having an easy way to get from a patch
730 email in your favorite mail client to the web page of the patch in the Patchwork
731 instance is a cool thing to have. Here's how to abuse the notmuch stash feature
732 to achieve this. (Don't know stash? See `notmuch-show-stash-mlarchive-link`,
733 bound to `c l` in `notmuch-show`.)
735 The trick needed is turning the email Message-ID into a unique Patchwork ID
736 assigned by Patchwork. We'll use the `pwclient` command-line tool to achieve
737 this. You'll first need to get that working and configured for the Patchwork
738 instance you're using. That part is beyond this tip here; please refer to
739 Patchwork documentation.
741 Check your configuration on the command-line, for example:
743 /path/to/pwclient -p <the-project> -n 5 -f "%{id}"
745 Note that the -f format argument may require a reasonably new version of the
746 client. Once you have the above working, you can `M-x customize-variable RET
747 notmuch-show-stash-mlarchive-link-alist RET`.
749 Add a new entry with "Function returning the URL:" set to:
752 (concat "http://patchwork.example.com/patch/"
754 (process-lines "/path/to/pwclient" "search"
756 "-m" (concat "<" message-id ">")
760 Replacing `http://patchwork.example.com/patch/`, `/path/to/pwclient`, and
761 `the-project` appropiately. You should now be able to stash the Patchwork URL
764 Going further, if the patch has been committed, you can get the commit hash with
769 (process-lines "/path/to/pwclient" "search"
771 "-m" (concat "<" message-id ">")
773 "-f" "%{commit_ref}")))
775 And finally, if the project has a web interface to its source repository, you
776 can turn the commit hash into a URL pointing there, for example:
779 (concat "http://cgit.example.com/the-project/commit/?id="
781 (process-lines "/path/to/pwclient" "search"
783 "-m" (concat "<" message-id ">")
785 "-f" "%{commit_ref}"))))