1 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
2 #Tips and Tricks for using notmuch with Emacs
4 The main client based on notmuch is notmuch.el, which is included in the notmuch package. It is might, and allows you to configure a lot of things, however, it might not be immediately obvious how, and how the general workflow generally looks like. This [first section](#typical_workflow) will describe a typical workflow and setup, while the section [Advanced tips and tweaks](#advanced_tips) below, focuses on more specific questions.
6 <h2 id="typical_workflow">Typical setup and workflow</h2>
8 ### Set up & receiving mails
10 Notmuch requires either a MailDir or a "mh"-style maildirectory to operate on. (It basically requires any setup in which each mail is in a file of it's own.) Most people use "[offlineimap](http://software.complete.org/software/projects/show/offlineimap)" or "[mbsync](http://isync.sourceforge.net/)" in order to synchronize their IMAP or pop mail server with a local mail store. offlineimap is quite useful and widely tested, it also offers a handy hook that will come in useful a bit later in our setup.
12 So go install and configure offlineimap so you can simply run offlineimap and have an updated maildir. In the [Account xxx] section of your .offineimaprc file your can specify a "presynchook" and "postsynchook" command that will get run whenever you sync. Point _postsynchook_ to a script that gets run on every sync and that will do the automatic tagging and updating of your notmuch database.
14 The script will look somewhat like this:
17 > # incorporate all new mails in the database
18 > notmuch new > /dev/null
19 > #apply some automatic tags
20 > notmuch tag +notmuch from:notmuch@notmuchmail.org and not tag:notmuch
21 > ...more tag rules...
23 If you don't need automatic tagging, just use "notmuch new > /dev/null" as your synchook. One advanced setup with automatic tagging has been described by James Vasile here (id: _87hbp5j9dv.fsf@hackervisions.org_). Carl Worth has described his script in this mail (id: _87r5o8stbj.fsf@yoom.home.cworth.org_) in the same thread.
25 > __A note on message ids__: Confused by those message ids? Get used to them, because they are an importance part of the notmuch workflow. Every send message has a unique message id, just like a website has a unique url. On the notmuch mailing list people will throw around message ids and expect people to just find the right mails, as this is what notmuch makes easy. In order to find a specific message, hit 's' for search and type: "id:messageidhere". If you incorporated the notmuch mail archive, you can e.g. try to find id:87r5o8stbj.fsf@yoom.home.cworth.org. Don't have the notmuch archive back to Feb 25, 2010? Fortunately gmane (and probably others allow to search for message id in their archives as well. You'll find this message under [http://mid.gmane.org/87r5o8stbj.fsf@yoom.home.cworth.org](http://mid.gmane.org/87r5o8stbj.fsf@yoom.home.cworth.org) (incidentally, this server seems to be down right now).
27 ### Synchronizing notmuch tags with maildir flags
28 IMAP users rely on maildir flags that convey the status "seen", "replied", "trashed", in order to synchronize the status of their mail across mail clients (a [maildir flag](http://cr.yp.to/proto/maildir.html) is simply a defined part of their filename). notmuch will by default happily ignore those flags and will never modify them either. If you want to use your mail with non-notmuch clients too, please check out the entry on "[how to sync notmuch tags and maildir flags](#sync_maildir_flags)".
30 ### Navigating & reading mails
31 OK, messages are now in your maildir and they have the tags you want them to have (of course you will be assigning more tags manually as you parse through your mail.). Now, on to actually using notmuch in emacs. If you added the correct bits to your .emacs file you will be able to start notmuch by typing "M-x notmuch" (or M-x notmuch-folder). If you want to start notmuch immediately when starting emacs you can also call emacs as "emacs -f notmuch" (and create a handy shortcut on your desktop for that).
33 notmuch (the search view) and notmuch-folder are the 2 main views that can be used to navigate through your mail.
34 The default notmuch "home" is a notmuch-search view with all all mail threads in which a message has been tagged as "inbox". Just navigate that page and read threads by hitting <RETURN> on one of them. This will open a notmuch thread view with all messages in this thread. Threads are a powerful construct in notmuch as a thread really represents a discussion around a single topic. In difference to other mail applications, you will often find very long threads in notmuch mail conversations, or people reviving very old threads with a reply.
36 The second way of navigating notmuch mails, is by using the notmuch-folder view which you can invoke with `M-x notmuch-folder` (or using the F key if you applied the patch from mail id: 1265889583-25406-1-git-send-email-dme@dme.org (Feb 11st, 2010)). For information on how to customize your notmuch-folder views, see [here](#customize_notmuch_folder). This view provides you with "virtual folders" that allow you to browse all emails topic-by-topic. For example, if you want to browse all notmuch related mail every 10 minutes, but check out mails from your boss only once a day, this will be one convenient way to do it. It will also give you a nice overview of how many (unread) emails you have for each folder. Those folders are virtual in that a mail can easily be part of several folders at the same time and the folders will be updated on-the-fly every time you hit `=`.
38 Last but not least, you can always search for a specific mail. Notmuch provides very powerful search possibilities which allows you to find mail threads easily without having to file them away into umpteenth mail folders as you might have been doing in your Thunderbird, Mail.app, or Outlook.
41 __[TODO, describe s, f, t keys and some exemplary searches]__.
42 __[TODO: describe common search strategies that notmuch users use]__
45 Notmuch itself does not provide any facilities for sending mail. Fortunately, emacs comes with "message mode" which offers that functionality. This also means that there are various methods to invoke the mail sending command. One possibility is to use "CTRL-x m" which will invoke a new "message mail" window. The second possibility is to type 'm' when you are in a notmuch window. And finally, when looking at a message or thread in notmuch you can type 'r' to start a reply.
47 If you want to use mail address autocompletion, check out [bbdb](http://bbdb.sourceforge.net) which works nicely together with message mode. There are also possibilities to use notmuch itself as an address book, see "[how to get email address completion](#address_completion)" on how to set that up.
49 Type your message and send it off with ctrl-c ctrl-c. By default message mode will use your /usr/sbin/sendmail command to send a mail, so make sure that works.
50 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.
53 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 <menu-bar> <Attachments> <Attach File...>, or the key binding `C-c RET f, C-c C-a`. For those of us who sometimes prefer graphics, you can also simply drag and drop files from a file
54 manager into a mail composition window to have it attached. The variable `mml-dnd-attach-options` (M-x customize-variable<RET>`mml-dnd-attach-options`) can be set to allow the prompting for various attachment options (such as inline/attachement) if you want to do that. At least in Ubuntu it works by dragging from the file manager without any modifications.
57 Currently, there is a slight problem with copying the sent mail into your "outbox". While conventional MUAs will automatically copy your sent mail to a "Sent" folder, notmuch will never touch your mail store and your sent mails will not be searchable by default. When replying with 'r' notmuch will insert a BCC header to yourself, but when sending a mail with 'm' or 'ctrl-x m', it will not (and can not as ctrl-x m does not involve notmuch at all). Please see the specific advice on "[how to do FCC/BCC](#fcc)" for more details on how to set up notmuch to obey your preferences.
59 ###3rd party application
61 As its name implies, notmuch isn't really doing that much (which is part of its appeal to many of us). However, it enables a whole ecosystem of surrounding scripts to work in conjunction with notmuch
63 * [notmuchsync](http://spaetz.github.com/notmuchsync/)
64 notmuchsync is a python tool that allows synchronization of maildir flags to/from notmuch tags.
65 * [cnotmuch](http://pypi.python.org/pypi/cnotmuch) python bindings for the notmuch shared library. Extensive API documentation available.
66 * [addrlookup](http://github.com/spaetz/vala-notmuch) vala spplication that can be used for interactive email address completion.
72 <h2 id="advanced_tips">Advanced tips and tweaks</h2>
73 * <span id="fcc">**How to do FCC/BCC...**</span>
75 Any notmuch reply will automatically include your primary email
76 address in a BCC so that any messages you send will (eventually) end
77 up in your mail store as well. But this doesn't do anything for
78 messages that you compose that are not replies.
80 Another method is described in [this
81 mail](http://mid.gmane.org/878wbj4nfq.fsf@servo.finestructure.net)
82 (id:878wbj4nfq.fsf@servo.finestructure.net). It involves a trivial
83 python script (which should be rewritten in lisp and integrated into
84 the notmuch frontend, really) but is not difficult to setup. It will
85 deliver your sent mail directly to the "sent" folder of you local
86 maildir repository (and thus be synchronized via offlineimap with
89 This is the code I needed in my .emacs file to make it work with
90 the python wrapper that I called mddeliver.py:
93 (defun maildir-deliver-region(destdir)
94 (shell-command-on-region
95 (point-min) (point-max)
96 (concat "/usr/local/bin/mddeliver.py -c -s -d " destdir)))
97 (setq message-fcc-handler-function 'maildir-deliver-region)
98 (defun my-message-header-setup ()
99 (message-add-header "Fcc: ~/mail/INBOX.Sent"))
100 (add-hook 'message-send-hook 'my-message-header-setup)
102 * <span id="customize_notmuch_folder">**How to customize notmuch-folders**</span>
104 There's a "notmuch-folder" command available in the emacs client
105 that displays a list of "folders" and the number of messages in
106 each. Each folder is simply a named search specification. To
107 configure this mode, edit your ${HOME}/.emacs file and include text
108 something like the following:
110 (setq notmuch-folders '(("inbox" . "tag:inbox")
111 ("unread" . "tag:inbox AND tag:unread")
112 ("notmuch" . "tag:inbox AND to:notmuchmail.org")))
114 Of course, you can have any number of folders, each configured
115 with any supported search terms (see "notmuch help search-terms").
117 Personally, I find it fairly useful to add "not tag:delete" to those
118 views as I use that tag to mark messages as deleted and it
119 automatically removes them from my standard views. Use whatever
120 seems most useful to you.
122 * **Viewing HTML messages with an external viewer**
124 The emacs client can often display an HTML message inline, but it
125 sometimes fails for one reason or another, (or is perhaps inadequate
126 if you really need to see the graphical presentation of the HTML
129 In this case, it can be useful to display the message in an external
130 viewer, such as a web browser. Here's a little script that Keith
131 Packard wrote, which he calls view-html:
136 cat "$@" > "$dir"/msg
137 if munpack -C "$dir" -t < "$dir"/msg 2>&1 | grep 'Did not find'; then
138 sed -n '/[Hh][Tt][Mm][Ll]/,$p' "$dir"/msg > $dir/part1.html
141 for i in "$dir"/part*; do
142 if grep -q -i -e '<html>' -e 'text/html' "$i"; then
149 Save that script somewhere in your ${PATH}, make it executable, and
150 change the invocation of iceweasel to any other HTML viewer if
151 necessary. Then within the emacs client, press "|" to pipe the
152 current message, then type "view-html".
154 Keith mentions the following caveat, "Note that if iceweasel isn't
155 already running, it seems to shut down when the script exits. I
158 * **msmtp, message mode and multiple accounts**
160 As an alternative to running a mail server such as sendmail or
161 postfix just to send email, it is possible to use
162 [msmtp](http://msmtp.sourceforge.net/). This small application will
163 look like /usr/bin/sendmail to a MUA such as emacs message mode, but
164 will just forward the email to an external SMTP server. It's fairly
165 easy to set up and it support several account for using different
166 SMTP servers. The msmtp pages have several examples.
168 A typical scenario is that you want to use the company SMTP server
169 for email coming from your company email address, and your personal
170 server for personal email. If msmtp is passed the envelope address
171 on the command line (the -f/--from option) it will automatically
172 pick the matching account. The only trick here seems to be getting
173 emacs to actually pass the envelope from. There are a number of
174 overlapping configuration variables that control this, and it's a
175 little confusion, but setting these three works for me:
177 - mail-specify-envelope-from: t
179 - message-sendmail-envelope-from: header
181 - mail-envelope-from: header
183 With that in place, you need a .msmtprc with the accounts configured
184 for the domains you want to send out using specific SMTP servers and
185 the rest will go to the default account.
187 * <span id="sync_maildir_flags">**how to sync notmuch tags and maildir
190 There is no built-in support for sunchronizing your notmuch tags
191 with your imap maildir flags (seen, replied, trashed, etc). However
192 there are currently 2 ways in which you can achieve
193 synchronization. In order to sync new notmuch tags to maildir flags,
194 there is a python tool called
195 [notmuchsync](http://spaetz.github.com/notmuchsync/) that allows
196 synchronization in either direction or pruning of deleted files.
198 The second solution allows for fast maildir flag to notmuch tag
199 synchronization (and only in that direction) requires patching the
200 notmuch source code. The patch has been posted in this mail
201 *id:1267450136-31749-1-git-send-email-Sebastian@SSpaeth.de* and can
202 be viewed as a [source diff in this git
203 repository](http://github.com/spaetz/notmuch-all-feature/commit/df3b087cefb85e9d16fd17540e348bcb854dd7ee).
205 * <span id="address_completion">**how to get email address completion**</span>
206 There are 2 solutions. Use "bbdb" which allows you to maintain a mail database and gives you mail address completion with the tab key.
208 Alternatively, you use the notmuch database as a mail address book
209 itself. You need a command line tool that outputs likely address
210 candidates based on a search string. There is a python tool
211 notmuch_address.py (which can be fetched with `git clone
212 http://jkr.acm.jhu.edu/git/notmuch_addresses.git`) (slower, but no
213 compilation required so good for testing the setup) or the
214 vala-based addrlookup (faster, but needs compiling). This is how
215 you compile the (3rd party) tool "addrlookup" to give you address
218 - you need the addrlookup binary, first of all. Grab http://github.com/spaetz/vala-notmuch/raw/static-sources/src/addrlookup.c and build it with `cc -o addrlookup addrlookup.c ``pkg-config --cflags --libs gobject-2.0`` -lnotmuch`. That should give you the binary that you can test already.
220 - EUDC is integrated into emacs and can be used for tab completion
221 of email addresses. The code I use is here
222 http://gist.github.com/359425. It was announce in [this
223 mail](http://mid.gmane.org/87fx3uflkx.fsf@jhu.edu)
224 (id:87fx3uflkx.fsf@jhu.edu) which contains links to the git
225 repositories which contain the files.
227 * <span id="insert_user_agent">**how to insert a user agent header**</span>
229 Sometimes it is good to let the world know which email client you use, so others know which quirks to expect. And it is no shame to let others know that you are way ahead of mail2.0. Notmuch is mail3.0 (at least)!
231 [This mail](http://mid.gmane.org/87y6gtnkch.fsf@SSpaeth.de) (id:87y6gtnkch.fsf@SSpaeth.de) posted the below code, that -when inserted in your .emacs file- will add a User-Agent header (which is hidden during composing and in notmuch show, but which can be seen when viewing all headers of a mail). The header will looke like this:
232 `User-Agent: notmuch version 0.1-92-g3893a9a (Emacs 23.1.1/x86_64-pc-linux-gnu)`
235 ;; set the User-Agent string whenever we invoke message mode
236 (add-hook 'message-mode-hook '(lambda()
237 ;; check if User-Agent is a required header and set it if not
238 (if (not (memq 'User-Agent message-required-mail-headers))
239 (setq message-required-mail-headers
240 (append message-required-mail-headers '(User-Agent))))
241 ;; hide the User-Agent header if not already hidden
242 (if (not (memq '"^User-Agent:" message-hidden-headers))
243 (setq message-hidden-headers
244 (append message-hidden-headers '("^User-Agent:"))))
245 ;; create user agent string
246 (let ((notmuch-user-agent (concat
247 (substring (shell-command-to-string (concat notmuch-command " --version")) 0 -1)
248 " (Emacs " emacs-version "/"
249 system-configuration ")")))
250 (setq message-newsreader notmuch-user-agent))
254 * <span id="sign_messages_gpg">**how to sign/encrypt my messages with
257 You can manually sign your messages with gpg by invoking `M-x
258 mml-secure-sign-pgpmime` (or `M-x
259 mml-secure-encrypt-pgpmime`). These functions are available via the
260 convenient (*cough cough*) keybindings `C-c C-m s p` and `C-c C-m c
261 p` by default. To sign my outgoing mail by default, I use this hook
264 ;;sign messages by default
265 (add-hook 'message-setup-hook 'mml-secure-sign-pgpmime)
267 This inserts the blurb `<#part sign=pgpmime>` into the beginning of
268 my mail text body and will be converted into a pgp signature when
269 sending (so I can just manually delete that line if I do not want a
projects / notmuch-wiki / blob