]> git.notmuchmail.org Git - notmuch-wiki/blobdiff - howto.mdwn
NEWS for release 0.23.4
[notmuch-wiki] / howto.mdwn
index ed36b933d0109e2645e605f4886dcc4b9b7825f0..74e7916de4d5b431972d77fd99e90041a2aa8c13 100644 (file)
@@ -1,3 +1,4 @@
+[[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
 # How to...
 
 Some tips about how to do some useful things with notmuch, and the
@@ -5,12 +6,6 @@ various "third party" notmuch utilities.
 
 [[!toc levels=2]]
 
-## <span id="debian_packages">**Debian squeeze packages outdated**</span>
-
-The notmuch package(s) in Debian squeeze are very old (version 0.3).
-It's better to start off with an up to date version from
-[backports](http://backports-master.debian.org/).
-
 ## <span id="receive_mail">**Receive mail**</span>
 
 Notmuch does not fetch mail for you.  For that, you need to use an
@@ -39,8 +34,26 @@ utilities support these formats:
 
 * [fetchmail](http://fetchmail.berlios.de/)
 
-See the [[initial_tagging]] page for more info on initial tagging of
-messages.
+* [muchsync](http://www.muchsync.org/) - replicate and synchronize
+  your notmuch database (mail and tags) across machines
+
+See more exhaustive list of [[software]] notmuch works with and the
+[[initial_tagging]] page for more info on initial tagging of messages.
+
+
+## <span id="send_mail">**Send mail**</span>
+
+Notmuch does not send your mail. The frontends (MUAs) that utilize notmuch
+does that. Often these MUAs use sendmail(8) to send your mail.
+
+If you prefer a simpler solution like msmtp, first
+[install and configure msmtp](http://msmtp.sourceforge.net/).
+
+Then create a symbolic link so that msmtp will be called instead of sendmail
+when you press the keyboard shortcut to send your message.
+
+    $ sudo ln -s /usr/bin/msmtp /usr/sbin/sendmail
+
 
 ## <span id="sync_maildir_flags">**Sync notmuch tags and maildir flags**</span>
 
@@ -62,71 +75,11 @@ refer to the mailing list.
 
 ## <span id="python">**Use notmuch from python**</span>
 
-Notmuch includes python bindings to the notmuch shared library. Please
-refer to the nice and extensive
-[notmuch python API documentation](http://notmuch.readthedocs.org/).
-
-The bindings are very simple to use.  As an example, given you have
-the python bindings installed (or simply set your PYTHONPATH
-environment variable to point to the .../bindings/python directory),
-this snippet will produce a list of mails matching the given
-expression:
-
-        >>> import notmuch
-        >>> db = notmuch.Database()
-        >>> query = db.create_query('tag:inbox AND NOT tag:killed')
-        >>> list(query.search_messages()) # doctest:+ELLIPSIS
-        [...]
+See the [[Notmuch Library Language Bindings|bindings]] page.
 
 ## <span id="print_filenames">**Using notmuch with Mutt**</span>
 
-Notmuch is a great mail indexing tool that can also be used *in conjunction*
-with existing Mail User Agents (MUA) instead of replacing them. The advantage
-of such mixed solutions is that users can benefit from notmuch features (such
-as full-text search and thread reconstruction) without *having to* change
-MUA.
-
-A popular geek MUA is [the Mutt e-mail client](http://www.mutt.org);
-integrating notmuch with Mutt is not seamless, but fairly straightforward.
-There are two principal possibilities, each with its own ups and downs:
-
-* Using mutt-notmuch, which will create a "virtual" maildir folder with
-  search results whenever a search is made. The upside is that you can
-  search all your folders simultanously; the downside is that your
-  modifications in the results listing do not carry over, also having
-  to switch folders comes with some more annoyances.
-
-  An
-  [**how to use Notmuch with Mutt**](http://upsilon.cc/~zack/blog/posts/2011/01/how_to_use_Notmuch_with_Mutt/)
-  has been written by Stefano Zacchiroli. Check out the
-  [howto](http://upsilon.cc/~zack/blog/posts/2011/01/how_to_use_Notmuch_with_Mutt/)
-  for more information.
-
-  <small>(Note by the howto author: I've linked the howto from this wiki rather
-  than splicing it in, in order to avoid duplication of information. If you
-  think it would be better to have it here, feel free to copy the text
-  here. The howto is
-  [available](http://git.upsilon.cc/cgi-bin/gitweb.cgi?p=zack-homepage.git;a=history;f=blog/posts/2011/01/how_to_use_Notmuch_with_Mutt.mdwn)
-  in markdown syntax from the Git repository of my homepage.)</small>
-
-* Using a simple macro that will emulate the "limit" mutt functionality
-  using notmuch.
-
-  See the [**alternative notmuch integration**](http://log.or.cz/?p=228)
-  blog post for instructions and details,
-  or simply put these two macros to your muttrc:
-
-        # 'L' performs a notmuch query, showing only the results
-        macro index L "<enter-command>unset wait_key<enter><shell-escape>read -p 'notmuch query: ' x; echo \$x >~/.cache/mutt_terms<enter><limit>~i \"\`notmuch search --output=messages \$(cat ~/.cache/mutt_terms) | head -n 600 | perl -le '@a=<>;chomp@a;s/\^id:// for@a;$,=\"|\";print@a'\`\"<enter>" "show only messages matching a notmuch pattern"
-        # 'a' shows all messages again (supersedes default <alias> binding)
-        macro index a "<limit>all\n" "show all messages (undo limit)"
-
-  The upside (if you are used to working in the context of a single folder)
-  is that this really does use the limit functionality of mutt
-  and you are still in your original folder.
-  The downside is that this approach has scaling problems
-  and works well only for reasonably specific queries.
-
+See [[notmuch-mutt]].
 
 ## <span id="reapply_auto">**Automatically retagging the database (e.g., when upgrading versions)**</span>
 
@@ -136,15 +89,15 @@ However, for users running with databases created in older versions of
 notmuch, these tags are missing in pre-existing messages and need to be
 added.  One way to do this is as follows:
 
-        $ notmuch dump ~/out.nm
+        $ notmuch dump --output=$HOME/out.nm
         $ mv ~/Mail/.notmuch ~/.notmuch.bak
         $ notmuch new
         $ notmuch tag -inbox -unread '*'
-        $ notmuch restore --accumulate ~/out.nm
+        $ notmuch restore --accumulate --input=$HOME/out.nm
 
 At this point, one should run a sanity check on the tags, and if everything
 has merged correctly, the ~/.notmuch.bak directory is expendable, as is
-~/out.nm.
+$HOME/out.nm.
 
 ## <span id="mbox">**Dealing with mbox and other formats**</span>
 
@@ -171,6 +124,22 @@ output.  Using the instructions from [Gmane's
 site](http://gmane.org/export.php), we can download an mbox file, which we
 can then convert to maildir using mb2md or other utility.
 
+Please note that mail delivered by Postfix will have envelope headers
+that may cause notmuch to complain about "single-message mbox files".
+Removing the first line from the message or passing it through
+reformail will solve the problem.
+
 ## <span id="special_tags">**Take advantage of tags that are special to notmuch**</span>
 
 See [[tags special to notmuch|special-tags]].
+
+
+## <span id="special_tags">**Index all your gpg-encrypted email**</span>
+
+If you don't mind replacing your encrypted emails with cleartext versions and
+re-indexing them, there are some scripts that do that at
+[github](https://github.com/mmehnert/maildir-decrypt) . That would make sense
+in a scenario where you have encrypted your hard disk anyway and are
+comfortable with the security implications (and until notmuch can index
+encrypted email itself).
+