X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=emacstips.mdwn;h=070edba3b653a318e2a515d5fcdf44bd1cf92c3e;hb=5f5765ced6969050be63278f8dc77939571a2489;hp=497f2d88abfdc241fec49db5db04aad76041df41;hpb=45e06041600ffd4840b660d6a898de14f7c7cc65;p=notmuch-wiki diff --git a/emacstips.mdwn b/emacstips.mdwn index 497f2d8..070edba 100644 --- a/emacstips.mdwn +++ b/emacstips.mdwn @@ -1,6 +1,10 @@ + + [[!img notmuch-logo.png alt="Notmuch logo" class="left"]] #Tips and Tricks for using notmuch with Emacs +[[!toc levels=2]] + The main Notmuch message reading client is **notmuch.el**, which is an [emacs](http://www.gnu.org/software/emacs/) major mode, and is included in the notmuch package. @@ -10,7 +14,11 @@ included in the notmuch package. To use the Notmuch emacs mode, first add the following line to your `.emacs` rc file: - (require 'notmuch) + (require 'notmuch) + +or you can load the package via autoload: + + (autoload 'notmuch "notmuch" "notmuch mail" t) Then, either run "emacs -f notmuch", or execute the command `M-x notmuch` from within a running emacs. @@ -45,24 +53,25 @@ messages. When in message mode, you can type `C-c ?` for help. If you would like to use address autocompletion when composing messages, see [address completion](#address_completion). -When you are ready to send a message, type `C-c C-c`. By default +When you are ready to send a message, type `C-c C-c`. By default message mode will use your sendmail command to send mail, so make sure -that works. One annoying standard configuration of message mode is +that works. One annoying standard configuration of message mode is 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 which will really close the mail window after -sending it. +in your `.emacs` file (or doing `M-x +customize-variablemessage-kill-buffer-on-exit`) which will +really close the mail window after sending it. ## Attaching files Using the `M-x mml-attach-file` command, you can attach any file to be -send with your mail. By default this command is bound to the menu item -*Attachments--Attach File* with the key binding `C-c C-a`. The +sent with your mail. By default this command is bound to the menu item +*Attachments--Attach File* with the key binding `C-c C-a`. The variable `mml-dnd-attach-options` (`M-x -customize-variablemml-dnd-attach-options`) can be set to allow -the prompting for various attachment options (such as +customize-variablemml-dnd-attach-options`) can be set to +allow the prompting for various attachment options (such as inline/attachment) if you want to do that. For those who prefer a more graphical interface, you can also simply @@ -75,20 +84,54 @@ script opens new emacs window with empty message and attaches files mentioned as script arguments. (Note: The script expects that you have `(server-start)` in your `.emacs` file.) - #!/bin/sh - attach_cmds="" - while [ "$1" ]; do - fullpath=$(readlink --canonicalize $1) - attach_cmds="$attach_cmds (mml-attach-file \"$fullpath\")" - shift - done - emacsclient -a '' -c -e "(progn (compose-mail) $attach_cmds)" + #!/bin/sh + attach_cmds="" + while [ "$1" ]; do + fullpath=$(readlink --canonicalize "$1") + attach_cmds="$attach_cmds (mml-attach-file \"$fullpath\")" + shift + done + emacsclient -a '' -c -e "(progn (compose-mail) $attach_cmds)" ----- # 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; + + ;(setq user-mail-address (notmuch-user-primary-email) + ; user-full-name (notmuch-user-name)) + + ; 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) + +Then, adto `.emacs`: + + (autoload 'notmuch "~/.emacs.d/my-notmuch" "notmuch mail" t) + + ## Add a key binding to add/remove/toggle a tag The `notmuch-{search,show}-{add,remove}-tag` functions are very useful @@ -96,36 +139,77 @@ for making quick tag key bindings. For instance, here's an example of how to make a key binding to add the "spam" tag and remove the "inbox" tag in notmuch-show-mode: - (define-key notmuch-show-mode-map "S" - (lambda () - "mark message as spam" - (interactive) - (notmuch-show-add-tag "spam") - (notmuch-show-remove-tag "inbox"))) +In notmuch versions up to 0.11.x + + (define-key notmuch-show-mode-map "S" + (lambda () + "mark message as spam" + (interactive) + (notmuch-show-add-tag "spam") + (notmuch-show-remove-tag "inbox"))) + +Starting from notmuch 0.12 (not released yet) the functions +`notmuch-show-add-tag` and `notmuch-show-remove-tag` have changed to +be more versatile and lost noninteractive use. When upgrading to 0.12 +the above needs to be changed to this: + + (define-key notmuch-show-mode-map "S" + (lambda () + "mark message as spam" + (interactive) + (notmuch-show-tag-message "+spam" "-inbox"))) You can do the same for threads in `notmuch-search-mode` by just replacing "show" with "search" in the called functions. +(Starting from notmuch 0.12 use `notmuch-search-tag-thread` instead) + The definition above makes use of a lambda function, but you could also define a separate function first: - (defun notmuch-show-tag-spam() - "mark message as spam" - (interactive) - (notmuch-show-add-tag "spam") - (notmuch-show-remove-tag "inbox"))) - (define-key notmuch-show-mode-map "S" 'notmuch-show-tag-spam) + (defun notmuch-show-tag-spam() + "mark message as spam" + (interactive) + (notmuch-show-add-tag "spam") + (notmuch-show-remove-tag "inbox"))) + (define-key notmuch-show-mode-map "S" 'notmuch-show-tag-spam) + +(See above for analogy how to apply this for notmuch 0.12 and later) Here's a more complicated example of how to add a toggle "deleted" key: - (define-key notmuch-show-mode-map "d" - (lambda () - "toggle deleted tag for message" - (interactive) - (if (member "deleted" (notmuch-show-get-tags)) - (notmuch-show-remove-tag "deleted") - (notmuch-show-add-tag "deleted")))) + (define-key notmuch-show-mode-map "d" + (lambda () + "toggle deleted tag for message" + (interactive) + (if (member "deleted" (notmuch-show-get-tags)) + (notmuch-show-remove-tag "deleted") + (notmuch-show-add-tag "deleted")))) + +And version for notmuch 0.12 (not released yet) + + (define-key notmuch-show-mode-map "d" + (lambda () + "toggle deleted tag for message" + (interactive) + (notmuch-show-tag-message + (if (member "deleted" (notmuch-show-get-tags)) + "-deleted" "+deleted")))) + +## Restore reply-to-all key binding to 'r' + +Starting from notmuch 0.12 the 'r' key is bound to reply-to-sender instead of +reply-to-all. Here's how to swap the reply to sender/all bindings in show mode: + + (define-key notmuch-show-mode-map "r" 'notmuch-show-reply) + (define-key notmuch-show-mode-map "R" 'notmuch-show-reply-sender) + +And in search mode: + + (define-key notmuch-search-mode-map "r" 'notmuch-search-reply-to-thread) + (define-key notmuch-search-mode-map "R" 'notmuch-search-reply-to-thread-sender) + ## How to do FCC/BCC... @@ -139,7 +223,7 @@ mail. Enter a directory (without the maildir `/cur` ending which will be appended automatically). To customize both variables at the same time, use the fancy command: - M-x customize-apropos\(notmuch-fcc-dirs\)\|\(message-directory\) + M-x customize-apropos\(notmuch-fcc-dirs\)\|\(message-directory\) This mechanism also allows you to select different folders to be used for the outgoing mail depending on your selected `From` @@ -157,9 +241,9 @@ customising the variable `notmuch-saved-searches`. An example setting might be: - (setq notmuch-saved-searches '(("inbox" . "tag:inbox") - ("unread" . "tag:inbox AND tag:unread") - ("notmuch" . "tag:inbox AND to:notmuchmail.org"))) + (setq notmuch-saved-searches '(("inbox" . "tag:inbox") + ("unread" . "tag:inbox AND tag:unread") + ("notmuch" . "tag:inbox AND to:notmuchmail.org"))) Of course, you can have any number of saved searches, each configured with any supported search terms (see "notmuch help search-terms"). @@ -172,30 +256,42 @@ useful to you. ## Viewing HTML messages with an external viewer -The emacs client can often display an HTML message inline, but it -sometimes fails for one reason or another, (or is perhaps inadequate -if you really need to see the graphical presentation of the HTML -message). - -In this case, it can be useful to display the message in an external -viewer, such as a web browser. Here's a little script that Keith -Packard wrote, which he calls `view-html`: - - #!/bin/sh - dir=`mktemp -d` - trap "rm -r $dir" 0 - cat "$@" > "$dir"/msg - if munpack -C "$dir" -t < "$dir"/msg 2>&1 | grep 'Did not find'; then - sed -n '/[Hh][Tt][Mm][Ll]/,$p' "$dir"/msg > $dir/part1.html - rm "$dir"/msg - fi - for i in "$dir"/part*; do - if grep -q -i -e '' -e 'text/html' "$i"; then - iceweasel "$i" & - sleep 3 - exit 0 - fi - done +The emacs client can display an HTML message inline using either the +`html2text` library or some text browser, like w3m or lynx. This is +controlled by the `mm-text-html-renderer` variable. + +The first option is theorically better, because it can generate +strings formatted for emacs and do whatever you want, e.g., substitute +text inside <b> tags for bold text in the buffer. The library, however +is still in a very early development phase and cannot yet process +properly many elements, like tables and