refer to the cli manpages from frontends

[obsolete/notmuch-wiki] / emacstips.mdwn

diff --git a/emacstips.mdwn b/emacstips.mdwn
index 18e2d84dd82a5f1fc8eec79decc9fb363f85a9ab..820d181725c7b02b2a16f7a80fe467638a9a9aac 100644 (file)
--- a/emacstips.mdwn
+++ b/emacstips.mdwn
@@ -3,13 +3,17 @@
 One of the more popular notmuch message reading clients is
 **notmuch.el**, an [emacs](http://www.gnu.org/software/emacs/) major
 mode for interacting with notmuch.  It is included in the notmuch
 One of the more popular notmuch message reading clients is
 **notmuch.el**, an [emacs](http://www.gnu.org/software/emacs/) major
 mode for interacting with notmuch.  It is included in the notmuch

-package.  This page goes over some usage tips for using notmuch with
-Emacs.
+package (notmuch-emacs in Debian).  This page goes over some usage
+tips for using notmuch with Emacs.

 
 [[!toc levels=2]]
 
 ## Setup
 
 
 [[!toc levels=2]]
 
 ## Setup
 

+Have a look at the [Howto](http://notmuchmail.org/howto/) for
+prerequisites.  Be sure you have done the general setup using the
+notmuch cli command!
+

 To use the Notmuch emacs mode, first add the following line to your
 `.emacs` rc file:
 
 To use the Notmuch emacs mode, first add the following line to your
 `.emacs` rc file:
 


@@ -25,8 +29,11 @@ notmuch` from within a running emacs.
 ## Navigating & reading mails
 
 When first starting notmuch in emacs, you will be presented with the
 ## Navigating & reading mails
 
 When first starting notmuch in emacs, you will be presented with the

-notmuch "hello" page.  From here you can do searches, see lists of
-recent searches, saved searches, message tags, help information, etc.
+notmuch "hello" page.  If it exits with an error after writing
+"Welcome to notmutch. You have" you need to do the basic notmuch setup
+first (see above).  
+From here you can do searches, see lists of recent
+searches, saved searches, message tags, help information, etc.

 
 Executing a search will open a new buffer in `notmuch-search-mode`
 displaying the search results.  Each line in the search results
 
 Executing a search will open a new buffer in `notmuch-search-mode`
 displaying the search results.  Each line in the search results


@@ -92,6 +99,17 @@ mentioned as script arguments. (Note: The script expects that you have
         done
         emacsclient -a '' -c -e "(progn (compose-mail) $attach_cmds)"
 
         done
         emacsclient -a '' -c -e "(progn (compose-mail) $attach_cmds)"
 

+## Issues with Emacs 24
+
+If notmuch-show-mode behaves badly for you in emacs 24.x try adding one of
+
+       (setq gnus-inhibit-images nil)
+
+or
+
+       (require 'gnus-art)
+
+to your .emacs file.

 
 -----
 
 
 -----
 


@@ -122,6 +140,8 @@ a file called `~/.emacs.d/my-notmuch.el`:
         ;; 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 & 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`:
 
 
 Then, add to `.emacs`:
 


@@ -255,12 +275,19 @@ And in search mode:
 The Emacs interface to notmuch will automatically add an `Fcc`
 header to your outgoing mail so that any messages you send will also
 be saved in your mail store. You can control where this copy of the
 The Emacs interface to notmuch will automatically add an `Fcc`
 header to your outgoing mail so that any messages you send will also
 be saved in your mail store. You can control where this copy of the

-message is saved by setting the variables `message-directory` (which
-defines a base directory) and `notmuch-fcc-dirs` which defines the
-subdirectory relative to `message-directory` in which to save the
-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:
+message is saved by setting the variable `notmuch-fcc-dirs` which defines the
+subdirectory relative to the `database.path` setting from your
+notmuch configuration in which to save the mail. Enter a directory
+(without the maildir `/cur` ending which will be appended
+automatically). Additional information can be found as usual using:
+
+       M-x describe-variable notmuch-fcc-dirs
+
+An additional variable that can affect FCC settings in some cases is
+`message-directory`. Emacs message-mode uses this variable for
+postponed messages.
+
+To customize both variables at the same time, use the fancy command:

 
         M-x customize-apropos<RET>\(notmuch-fcc-dirs\)\|\(message-directory\)
 
 
         M-x customize-apropos<RET>\(notmuch-fcc-dirs\)\|\(message-directory\)
 


@@ -526,3 +553,121 @@ more information (some of these have "extensive documentation"):
 The last two do the same thing.
 
 See also the **Usage:** section in `gnus-alias.el`.
 The last two do the same thing.
 
 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.
+
+        (define-key notmuch-show-mode-map "b"
+          (lambda (&optional address)
+            "Bounce the current message."
+            (interactive "sBounce To: ")
+            (notmuch-show-view-raw-message)
+            (message-resend 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.
+
+        (defvar notmuch-hello-refresh-count 0)
+
+        (defun notmuch-hello-refresh-status-message ()
+          (unless no-display
+            (let* ((new-count
+                    (string-to-number
+                     (car (process-lines notmuch-command "count"))))
+                   (diff-count (- new-count notmuch-hello-refresh-count)))
+              (cond
+               ((= notmuch-hello-refresh-count 0)
+                (message "You have %s messages."
+                         (notmuch-hello-nice-number new-count)))
+               ((> diff-count 0)
+                (message "You have %s more messages since last refresh."
+                         (notmuch-hello-nice-number diff-count)))
+               ((< diff-count 0)
+                (message "You have %s fewer messages since last refresh."
+                         (notmuch-hello-nice-number (- diff-count)))))
+              (setq notmuch-hello-refresh-count new-count))))
+
+        (add-hook 'notmuch-hello-refresh-hook 'notmuch-hello-refresh-status-message)
+
+## Replacing tabs with spaces in subject and header
+
+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:
+
+       (defun notmuch-show-subject-tabs-to-spaces ()
+         "Replace tabs with spaces in subject line."
+         (goto-char (point-min))
+         (when (re-search-forward "^Subject:" nil t)
+           (while (re-search-forward "\t" (line-end-position) t)
+             (replace-match " " nil nil))))
+
+       (add-hook 'notmuch-show-markup-headers-hook 'notmuch-show-subject-tabs-to-spaces)
+
+And in header lines (this will only work with the yet to be released
+notmuch version 0.15):
+
+       (defun notmuch-show-header-tabs-to-spaces ()
+         "Replace tabs with spaces in header line."
+         (setq header-line-format
+               (notmuch-show-strip-re
+                (replace-regexp-in-string "\t" " " (notmuch-show-get-subject)))))
+
+       (add-hook 'notmuch-show-hook 'notmuch-show-header-tabs-to-spaces)
+
+## Hiding unread messages in notmuch-show
+
+I like to have an inbox saved search, but only show unread messages when they
+view a thread. This takes two steps:
+
+1. Apply
+[this patch from Mark Walters](http://notmuchmail.org/pipermail/notmuch/2012/010817.html)
+to add the `notmuch-show-filter-thread` function.
+1. Add the following hook to your emacs configuration:
+
+        (defun expand-only-unread-hook () (interactive)
+          (let ((unread nil)
+                (open (notmuch-show-get-message-ids-for-open-messages)))
+            (notmuch-show-mapc (lambda ()
+                                 (when (member "unread" (notmuch-show-get-tags))
+                                   (setq unread t))))
+            (when unread
+              (let ((notmuch-show-hook (remove 'expand-only-unread-hook notmuch-show-hook)))
+                (notmuch-show-filter-thread "tag:unread")))))
+
+        (add-hook 'notmuch-show-hook 'expand-only-unread-hook)
+
+## Changing the color of a saved search based on some other search
+
+I like to have a saved search for my inbox, but have it change color when there
+are thread with unread messages in the inbox. I accomplish this with the
+following code in my emacs config:
+
+        (defun color-inbox-if-unread () (interactive)
+          (save-excursion
+            (goto-char (point-min))
+            (let ((cnt (car (process-lines "notmuch" "count" "tag:inbox and tag:unread"))))
+              (when (> (string-to-number cnt) 0)
+                (save-excursion
+                  (when (search-forward "inbox" (point-max) t)
+                    (let* ((overlays (overlays-in (match-beginning 0) (match-end 0)))
+                           (overlay (car overlays)))
+                      (when overlay
+                        (overlay-put overlay 'face '((:inherit bold) (:foreground "green")))))))))))
+        (add-hook 'notmuch-hello-refresh-hook 'color-inbox-if-unread)
+               
+## Linking to notmuch messages and threads from the Circe IRC client
+
+[Circe](https://github.com/jorgenschaefer/circe/wiki) is an IRC client for emacs.
+To have clickable buttons for notmuch messages and threads, add the following to 
+`lui-buttons-list` (using, e.g. M-x customize-variable)
+
+    ("\\(?:id\\|mid\\|thread\\):[0-9A-Za-z][0-9A-Za-z.@-]*" 0 notmuch-show 0)
+       
+If you have notmuch-pick installed, it works fine for this as well.