To use the Notmuch emacs mode, first add the following line to your
`.emacs` rc file:
- (require 'notmuch)
+ (autoload 'notmuch "notmuch" "notmuch mail" t)
-or you can load the package via autoload:
+or if you always want to load notmuch when you start emacs:
- (autoload 'notmuch "notmuch" "notmuch mail" t)
+ (require 'notmuch)
Then, either run "emacs -f notmuch", or execute the command `M-x
notmuch` from within a running emacs.
+### <span id="notmuch_init_file"> Notmuch Emacs configuration file: </span>
+
+(Since Notmuch 0.18)
+
+After notmuch is loaded `notmuch-init-file` (typically
+ `~/.emacs.d/notmuch-config.el`) is checked out. If such file exists
+it is loaded. Most emacs lisp based configuration not suitable via
+customization can be put there instead of `~/.emacs`.
+
## Navigating & reading mails
When first starting notmuch in emacs, you will be presented with the
not close it. If you type several mails in an emacs session they will
accumulate and make switching between buffers more annoying. You can
avoid that behavior by adding `(setq message-kill-buffer-on-exit t)`
-in your `.emacs` file (or doing `M-x
-customize-variable<RET>message-kill-buffer-on-exit<RET>`) which will
-really close the mail window after sending it.
+in your `.emacs` file
+(or doing `M-x customize-variable<RET>message-kill-buffer-on-exit<RET>`)
+which will really close the mail window after sending it.
## Attaching files
#!/bin/sh
attach_cmds=""
- while [ "$1" ]; do
+ while [ $# -gt 0 ]; do
fullpath=$(readlink --canonicalize "$1")
attach_cmds="$attach_cmds (mml-attach-file \"$fullpath\")"
shift
done
emacsclient -a '' -c -e "(progn (compose-mail) $attach_cmds)"
+## Controlling external handlers for attachements
+
+You can choose e.g. which pdf viewer to invoke from notmuch-show mode by
+adding a .mailcap file in your home directory. Here is an example:
+
+ application/pdf; /usr/bin/mupdf %s; test=test "$DISPLAY" != ""; description=Portable Document Format; nametemplate=%s.pdf
+ application/x-pdf; /usr/bin/mupdf %s; test=test "$DISPLAY" != ""; description=Portable Document Format; nametemplate=%s.pdf
+
## Issues with Emacs 24
If notmuch-show-mode behaves badly for you in emacs 24.x try adding one of
# Advanced tips and tweaks
-## Use separate emacs lisp file for notmuch configuration
-
-Instead of adding notmuch configuration code to `.emacs`, there
-is an option to collect those to a separate file (which is only
-loaded when `notmuch` is invoked). To do this, write, for example
-a file called `~/.emacs.d/my-notmuch.el`:
-
- ;;; my-notmuch.el -- my notmuch mail configuration
- ;;;
-
- ;;; add here stuff required to be configured *before*
- ;;; notmuch is loaded;
-
- ;; uncomment and modify in case some elisp files are not found in load-path
- ;; (add-to-list 'load-path "~/vc/ext/notmuch/emacs")
-
- ;;; load notmuch
- (require 'notmuch)
-
- ;;; add here stuff required to be configured *after*
- ;;; notmuch is loaded;
-
- ;; uncomment & modify if you want to use external smtp server to send mail
- ;; (setq smtpmail-smtp-server "smtp.server.tld"
- ;; message-send-mail-function 'message-smtpmail-send-it)
- ;; uncomment to debug smtp sending problems
- ;; (setq smtpmail-debug-info t)
-
-Then, add to `.emacs`:
-
- (autoload 'notmuch "~/.emacs.d/my-notmuch" "notmuch mail" t)
-
## Initial cursor position in notmuch 0.15 hello window
In notmuch version 0.15 emacs client the handling of cursor position in
The `notmuch-{search,show,tree}-tag` functions are very useful for
making quick tag key bindings. The arguments to these functions have
changed as notmuch has evolved but the following should work on all
-versions of notmuch 0.13 and later. These functions take a list of
+versions of notmuch from 0.13 on. These functions take a list of
tag changes as argument. For example, an argument of (list "+spam"
-"-inbox) adds the tag spam and deletes the tag inbox. Note the
+"-inbox") adds the tag spam and deletes the tag inbox. Note the
argument must be a list even if there is only a single tag change
e.g., use (list "+deleted") to add the deleted tag.
you want to tag a whole thread in `notmuch-tree-mode` use
`notmuch-tree-tag-thread` instead of `notmuch-tree-tag`.
+You may also want the function in search mode apply to the all threads
+in the selected region (if there is one). For notmuch prior to 0.17
+this behaviour will occur automatically with the functions given
+above. To get this behaviour on 0.17+ do the following:
+
+ (define-key notmuch-search-mode-map "S"
+ (lambda (&optional beg end)
+ "mark thread as spam"
+ (interactive (notmuch-search-interactive-region))
+ (notmuch-search-tag (list "+spam" "-inbox") beg end)))
+
+The analogous functionality in notmuch-tree is currently missing.
+
The definitions above make use of a lambda function, but you could
also define a separate function first:
from notmuch. It also includes a vim plugin.
You can perform tab-completion using any of these programs.
-Just add the following to your .emacs:
+Just add the following to your [notmuch init file](#notmuch_init_file):
(require 'notmuch-address)
(setq notmuch-address-command "/path/to/address_fetching_program")
cd build
cmake ..; make;
-You will find the akonadimailsearch binary in the build/src directory.
-Create a ~/bin/akonadimailsearch.sh file with the following content and make it executable:
-(Adjust the path for the akonadimailsearch binary.)
-
- #!/bin/sh
- akonadimailsearch "$@" 2>/dev/null
+You will find the akonadimailsearch binary in the build/src directory. Copy it to ~/bin .
-As described above, you can now add the following settings to your ~/.emacs file:
+You can now add the following settings to your
+[notmuch init file](#notmuch_init_file):
(require 'notmuch-address)
- (setq notmuch-address-command "~/bin/akonadimailsearch.sh")
+ (setq notmuch-address-command "~/bin/akonadimailsearch")
(notmuch-address-message-insinuate)
+### Completion selection with helm
+
+An address query might return multiple possible matches from which you
+will have to select one. To ease this task, several different
+frameworks in emacs support completion selection. One of them is
+[helm](https://github.com/emacs-helm/helm). The following snippet
+improves the out-of-the-box support for helm in notmuch as it enables
+the required-match option and also does not ignore the first returned
+address.
+
+ (setq notmuch-address-selection-function
+ (lambda (prompt collection initial-input)
+ (completing-read prompt (cons initial-input collection) nil t nil 'notmuch-address-history)))
## How to sign/encrypt messages with gpg
installed, it will shadow the fixed version of easypg included with
emacs.
+## Reading and verifying encrypted and signed messages
+
+Encrypted and signed mime messages can be read and verified with:
+
+ (notmuch-crypto-process-mime t)
+
+Decrypting or verifying inline pgp messages can be done by selecting
+an the inline pgp area and and using:
+
+ M-x epa-decrypt-region RET
+
## Multiple identities using gnus-alias
[gnus-alias](http://www.emacswiki.org/emacs/GnusAlias) allows you to
## Resending (or bouncing) messages
-Add the following to your `.emacs` to be able to resend the current message in
-show mode.
+Add the following to your [notmuch init file](#notmuch_init_file) to be able
+to resend the current message in show mode.
(define-key notmuch-show-mode-map "b"
(lambda (&optional address)
## `notmuch-hello` refresh status message
-Add the following to your `.emacs` to get a status message about the change in
-the number of messages in the mail store when refreshing the `notmuch-hello`
-buffer.
+Add the following to your [notmuch init file](#notmuch_init_file) to get a
+status message about the change in the number of messages in the mail store
+when refreshing the `notmuch-hello` buffer.
(defvar notmuch-hello-refresh-count 0)
Mailman mailing list software rewrites and rewraps long message subjects in
a way that causes TABs to appear in the middle of the subject and header
-lines. Add this to your `.emacs` to replace tabs with spaces in subject
-lines:
+lines. Add this to your [notmuch init file](#notmuch_init_file) to replace
+tabs with spaces in subject lines:
(defun notmuch-show-subject-tabs-to-spaces ()
"Replace tabs with spaces in subject line."
In Debian and derivatives,
- (add-to-list 'load-path "/usr/share/org-mode/lisp")
+ (add-to-list 'load-path "/usr/share/org-mode/lisp")
Then
- (require 'org-notmuch)
+ (require 'org-notmuch)
In general it is nice to have a key for org-links (not just for notmuch). For example
projects / notmuch-wiki / blobdiff