]> git.cworth.org Git - notmuch-wiki/blobdiff - emacstips.mdwn
added a section about helm and address completion
[notmuch-wiki] / emacstips.mdwn
index 1d73550528617ef07b6e3fb00f6159ef7e2cab77..3f217febaee30b195ef930479e01e452be4112d3 100644 (file)
@@ -27,16 +27,14 @@ or if you always want to load notmuch when you start emacs:
 Then, either run "emacs -f notmuch", or execute the command `M-x
 notmuch` from within a running emacs.
 
-### Notmuch Emacs configuration file:
+### <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`. As this is so new
-feature rest of this emacstips file is not yet adjusted to refer this
-file instead of .emacs.
+customization can be put there instead of `~/.emacs`.
 
 ## Navigating & reading mails
 
@@ -78,9 +76,9 @@ that it will hide the sent mail in your emacs frame stack, but it will
 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
 
@@ -104,13 +102,21 @@ mentioned as script arguments. (Note: The script expects that you have
 
         #!/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
@@ -158,7 +164,7 @@ 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 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.
 
@@ -449,7 +455,7 @@ available:
     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")
@@ -487,12 +493,26 @@ Create a ~/bin/akonadimailsearch.sh file with the following content and make it
         #!/bin/sh
         akonadimailsearch "$@" 2>/dev/null
 
-As described above, you can now add the following settings to your ~/.emacs file:
+As described above, 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")
         (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
@@ -523,6 +543,17 @@ part.
   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
@@ -592,8 +623,8 @@ See also the **Usage:** section in `gnus-alias.el`.
 
 ## 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)
@@ -604,9 +635,9 @@ show mode.
 
 ## `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)
 
@@ -634,8 +665,8 @@ buffer.
 
 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."
@@ -715,11 +746,11 @@ but as a contrib file, so you might have to work a bit to load it.
 
 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