git.cworth.org Git - notmuch-wiki/blob - howto.mdwn

   1 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
   2 # How to...
   3
   4 Some tips about how to do some useful things with notmuch, and the
   5 various "third party" notmuch utilities.
   6
   7 [[!toc levels=2]]
   8
   9 ## <span id="receive_mail">**Receive mail**</span>
  10
  11 Notmuch does not fetch mail for you.  For that, you need to use an
  12 external mail syncing utility.  Some recommended utilities are listed
  13 below.
  14
  15 Notmuch requires that every individual message be in it's own file.
  16 The well-supported [maildir](http://cr.yp.to/proto/maildir.html) or
  17 "mh"-style storage formats are compatible with notmuch.  Basically any
  18 setup in which each mail is in a file of its own will work.  The older
  19 mbox mail store formats is not supported, but fortunately it is very
  20 easy to [[convert mbox to maildir|howto/#mbox]] .  The following
  21 utilities support these formats:
  22
  23 * [offlineimap](http://offlineimap.org/) -
  24   quite useful and widely tested, it also offers a handy hook that
  25   will come in useful a bit later in our setup.  Also supports
  26   "presynchook" and "postsynchook" command that will get run
  27   whenever you sync.  Point _postsynchook_ to a script that gets run
  28   on every sync and that will do the automatic updating and tagging
  29   of your notmuch database.
  30
  31 * [mbsync](http://isync.sourceforge.net/)
  32
  33 * [getmail](http://pyropus.ca/software/getmail/)
  34
  35 * [fetchmail](http://fetchmail.berlios.de/)
  36
  37 * [muchsync](http://www.muchsync.org/) - replicate and synchronize
  38   your notmuch database (mail and tags) across machines
  39
  40 See more exhaustive list of [[software]] notmuch works with and the
  41 [[initial_tagging]] page for more info on initial tagging of messages.
  42
  43
  44 ## <span id="send_mail">**Send mail**</span>
  45
  46 Notmuch does not send your mail. The frontends (MUAs) that utilize notmuch
  47 does that. Often these MUAs use sendmail(8) to send your mail.
  48
  49 If you prefer a simpler solution like msmtp, first
  50 [install and configure msmtp](http://msmtp.sourceforge.net/).
  51
  52 Then create a symbolic link so that msmtp will be called instead of sendmail
  53 when you press the keyboard shortcut to send your message.
  54
  55     $ sudo ln -s /usr/bin/msmtp /usr/sbin/sendmail
  56
  57
  58 ## <span id="sync_maildir_flags">**Sync notmuch tags and maildir flags**</span>
  59
  60 notmuch has the ability to synchronize maildir flags and respective tags in both
  61 directions. For more information on maildir flags see the [maildir
  62 page](http://cr.yp.to/proto/maildir.html), and for the respective tags see your
  63 notmuch configuration file. This feature is enabled by default, but if you don't
  64 need it, it is simple to disable it with the 'notmuch config' command:
  65
  66         $ notmuch config set maildir.synchronize_flags false
  67
  68 The maildir flags may, in turn, be synchronized with IMAP flags by another tool,
  69 such as offlineimap.
  70
  71 For safety reasons, and because
  72 [[notmuch does not support delete operations|deleting]], notmuch does
  73 not sync the "trashed" flag.  For discussion on this topic please
  74 refer to the mailing list.
  75
  76 ## <span id="python">**Use notmuch from python**</span>
  77
  78 See the [[Notmuch Library Language Bindings|bindings]] page.
  79
  80 ## <span id="print_filenames">**Using notmuch with Mutt**</span>
  81
  82 See [[notmuch-mutt]].
  83
  84 ## <span id="reapply_auto">**Automatically retagging the database (e.g., when upgrading versions)**</span>
  85
  86 Certain versions of notmuch include new automatic tags (for example, between
  87 0.3 and 0.10, automatic tagging of signed and encrypted messages was added).
  88 However, for users running with databases created in older versions of
  89 notmuch, these tags are missing in pre-existing messages and need to be
  90 added.  One way to do this is as follows:
  91
  92         $ notmuch dump --output=$HOME/out.nm
  93         $ mv ~/Mail/.notmuch ~/.notmuch.bak
  94         $ notmuch new
  95         $ notmuch tag -inbox -unread '*'
  96         $ notmuch restore --accumulate --input=$HOME/out.nm
  97
  98 At this point, one should run a sanity check on the tags, and if everything
  99 has merged correctly, the ~/.notmuch.bak directory is expendable, as is
 100 $HOME/out.nm.
 101
 102 ## <span id="mbox">**Dealing with mbox and other formats**</span>
 103
 104 notmuch by itself is unable to handle non-maildir mail archives.  One tool
 105 to solve this is called mb2md.  Assuming an mbox in ~/test.mbox and ones
 106 mail archives to be in ~/Mail, an invocation would look like
 107
 108         $ mb2md -s ~/test.mbox -d ~/Mail/mynewmaildirname
 109
 110 Note that specifying the paths for -s and -d is necessary.  This will create
 111 a new maildir in ~/Mail/mynewmaildirname from the mbox at ~/test.mbox.
 112
 113 Often the formats are more convoluted, however.  Many lists provide an
 114 almost-but-not-quite-mbox format that mailman produces, as can be seen, for
 115 example, [here](http://lists.xapian.org/pipermail/xapian-devel/).  These
 116 files can be converted with some degree of success to mbox using the script
 117 found
 118 [here](http://www.hermann-uwe.de/blog/converting-mailman-gzipd-text-archive-files-to-proper-mbox-files),
 119 and from mbox to maildir as above.
 120
 121 However, many of these lists also have a gmane version, which, where it
 122 exists, achieves far better results than dealing with the messy mailman
 123 output.  Using the instructions from [Gmane's
 124 site](http://gmane.org/export.php), we can download an mbox file, which we
 125 can then convert to maildir using mb2md or other utility.
 126
 127 Please note that mail delivered by Postfix will have envelope headers
 128 that may cause notmuch to complain about "single-message mbox files".
 129 Removing the first line from the message or passing it through
 130 reformail will solve the problem.
 131
 132 ## <span id="special_tags">**Take advantage of tags that are special to notmuch**</span>
 133
 134 See [[tags special to notmuch|special-tags]].
 135
 136
 137 ## <span id="special_tags">**Index all your gpg-encrypted email**</span>
 138
 139 If you don't mind replacing your encrypted emails with cleartext versions and
 140 re-indexing them, there are some scripts that do that at
 141 [github](https://github.com/mmehnert/maildir-decrypt) . That would make sense
 142 in a scenario where you have encrypted your hard disk anyway and are
 143 comfortable with the security implications (and until notmuch can index
 144 encrypted email itself).
 145