]> git.cworth.org Git - notmuch-old/blob - contrib/notmuch-deliver/README.mkd
Merge branch 'release'
[notmuch-old] / contrib / notmuch-deliver / README.mkd
1 ## About
2 `notmuch-deliver` is a [maildir](http://cr.yp.to/proto/maildir.html) delivery
3 tool.
4
5 ## Overview
6 `notmuch-deliver` is a [maildir](http://cr.yp.to/proto/maildir.html) delivery
7 tool for [notmuch](http://notmuchmail.org) mail indexer. It reads from standard
8 input, delivers the mail to the specified maildir and adds it to the notmuch
9 database. This is meant as a convenient alternative to running `notmuch new`
10 after mail delivery.
11
12 ## Usage
13 Here's a simple example for [maildrop](http://www.courier-mta.org/maildrop/):
14
15     # Deliver local mail to $MAILDIR/.Local and add local tag.
16     if (/^From: root/:h)
17     {
18       to "|notmuch-deliver -f -t local Local"
19     }
20
21     # Deliver lkml mail to $MAILDIR/.Lkml, add lkml tag and remove inbox tag.
22     if (/^List-Id: linux-kernel@vger.kernel.org/:h)
23     {
24       to "|notmuch-deliver -f -t lkml -r inbox Lkml"
25     }
26
27     # Deliver the rest to $MAILDIR, adding personal tag
28     to "|notmuch-deliver -t personal"
29
30 ## Requirements
31 - [notmuch](http://notmuchmail.org) shared library
32 - [GLib](http://library.gnome.org/devel/glib/)-2.16 or newer
33
34 ## Contribute
35 Clone [git://github.com/alip/notmuch-deliver.git](git://github.com/alip/notmuch-deliver.git).  
36 Format patches are preferred. Either send a mail to me or poke me on IRC.  
37 My personal e-mail address is [alip@exherbo.org](mailto:alip@exherbo.org).  
38 I'm available on IRC as `alip` on [Freenode](http://freenode.net) and [OFTC](http://www.oftc.net).
39
40 ## License
41 You may redistribute this under the same terms as notmuch itself.
42
43 <!-- vim: set ft=mkd spell spelllang=en sw=4 sts=4 et : -->