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://www.fetchmail.info/)
  36
  37 * [muchsync](http://www.muchsync.org/) - replicate and synchronize
  38   your notmuch database (mail and tags) across machines
  39
  40 * [gmailieer](https://github.com/gauteh/gmailieer) - Fast email-fetching and two-way tag synchronization between notmuch and GMail
  41
  42 See more exhaustive list of [[software]] notmuch works with and the
  43 [[initial_tagging]] page for more info on initial tagging of messages.
  44
  45
  46 ## <span id="send_mail">**Send mail**</span>
  47
  48 Notmuch does not send your mail. The frontends (MUAs) that utilize notmuch
  49 does that. Often these MUAs use sendmail(8) to send your mail.
  50
  51 If you prefer a simpler solution like msmtp, first
  52 [install and configure msmtp](http://msmtp.sourceforge.net/).
  53
  54 Then create a symbolic link so that msmtp will be called instead of sendmail
  55 when you press the keyboard shortcut to send your message.
  56
  57     $ sudo ln -s /usr/bin/msmtp /usr/sbin/sendmail
  58
  59
  60 ## <span id="sync_maildir_flags">**Sync notmuch tags and maildir flags**</span>
  61
  62 notmuch has the ability to synchronize maildir flags and respective tags in both
  63 directions. For more information on maildir flags see the [maildir
  64 page](http://cr.yp.to/proto/maildir.html) and [[Special tags|special-tags]], and for the respective tags see your
  65 notmuch configuration file. This feature is enabled by default, but if you don't
  66 need it, it is simple to disable it with the 'notmuch config' command:
  67
  68         $ notmuch config set maildir.synchronize_flags false
  69
  70 The maildir flags may, in turn, be synchronized with IMAP flags by another tool,
  71 such as offlineimap.
  72
  73 For safety reasons, and because
  74 [[notmuch does not support delete operations|deleting]], notmuch does
  75 not sync the "trashed" flag.  For discussion on this topic please
  76 refer to the mailing list.
  77
  78 ## <span id="python">**Use notmuch from python**</span>
  79
  80 See the [[Notmuch Library Language Bindings|bindings]] page.
  81
  82 ## <span id="print_filenames">**Using notmuch with Mutt**</span>
  83
  84 See [[notmuch-mutt]].
  85
  86 ## <span id="reapply_auto">**Automatically retagging the database (e.g., when upgrading versions)**</span>
  87
  88 Certain versions of notmuch include new automatic tags (for example, between
  89 0.3 and 0.10, automatic tagging of signed and encrypted messages was added).
  90 However, for users running with databases created in older versions of
  91 notmuch, these tags are missing in pre-existing messages and need to be
  92 added.  One way to do this is as follows:
  93
  94         $ notmuch dump --output=$HOME/out.nm
  95         $ mv ~/Mail/.notmuch ~/.notmuch.bak
  96         $ notmuch new
  97         $ notmuch tag -inbox -unread '*'
  98         $ notmuch restore --accumulate --input=$HOME/out.nm
  99
 100 At this point, one should run a sanity check on the tags, and if everything
 101 has merged correctly, the ~/.notmuch.bak directory is expendable, as is
 102 $HOME/out.nm.
 103
 104 ## <span id="mbox">**Dealing with mbox and other formats**</span>
 105
 106 notmuch by itself is unable to handle non-maildir mail archives.  One tool
 107 to solve this is called mb2md.  Assuming an mbox in ~/test.mbox and ones
 108 mail archives to be in ~/Mail, an invocation would look like
 109
 110         $ mb2md -s ~/test.mbox -d ~/Mail/mynewmaildirname
 111
 112 Note that specifying the paths for -s and -d is necessary.  This will create
 113 a new maildir in ~/Mail/mynewmaildirname from the mbox at ~/test.mbox.
 114
 115 Often the formats are more convoluted, however.  Many lists provide an
 116 almost-but-not-quite-mbox format that mailman produces, as can be seen, for
 117 example, [here](http://lists.xapian.org/pipermail/xapian-devel/).  These
 118 files can be converted with some degree of success to mbox using the script
 119 found
 120 [here](http://www.hermann-uwe.de/blog/converting-mailman-gzipd-text-archive-files-to-proper-mbox-files),
 121 and from mbox to maildir as above.
 122
 123 However, many of these lists also have a gmane version, which, where it
 124 exists, achieves far better results than dealing with the messy mailman
 125 output.  Using the instructions from [Gmane's
 126 site](http://gmane.org/export.php), we can download an mbox file, which we
 127 can then convert to maildir using mb2md or other utility.
 128
 129 Please note that mail delivered by Postfix will have envelope headers
 130 that may cause notmuch to complain about "single-message mbox files".
 131 Removing the first line from the message or passing it through
 132 reformail will solve the problem.
 133
 134 ## <span id="special_tags">**Take advantage of tags that are special to notmuch**</span>
 135
 136 See [[tags special to notmuch|special-tags]].
 137
 138
 139 ## <span id="special_tags">**Index all your gpg-encrypted email**</span>
 140
 141 If you don't mind replacing your encrypted emails with cleartext versions and
 142 re-indexing them, there are some scripts that do that at
 143 [github](https://github.com/mmehnert/maildir-decrypt) . That would make sense
 144 in a scenario where you have encrypted your hard disk anyway and are
 145 comfortable with the security implications (and until notmuch can index
 146 encrypted email itself).
 147
 148 ## Translations
 149
 150 - A translation of this page into [[Russian|howto-ru]]