File: quickstart.rst

package info (click to toggle)
afew 3.0.1-8
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 660 kB
  • sloc: python: 1,484; makefile: 10; sh: 6
file content (71 lines) | stat: -rw-r--r-- 1,579 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
Quick Start
===========

The steps to get up and running are:

* install the afew package
* create the config files
* add a notmuch post-new hook that calls afew

Install
-------

The following commands will get you going on Debian/Ubuntu systems:

.. code-block:: sh

    $ sudo aptitude install notmuch python-notmuch dbacl
    $ git clone git://github.com/teythoon/afew.git
    $ cd afew
    $ python setup.py install --prefix=~/.local

Ensure that `~/.local/bin` is in your path. One way is to add the following to
your `~/.bashrc`:

.. code-block:: sh

    if [ -d ~/.local/bin ]; then
        PATH=$PATH:~/.local/bin
    fi

See :doc:`installation` for a more detailed guide.

Initial Config
--------------

Make sure that `~/.notmuch-config` reads:

.. code-block:: ini

    [new]
    tags=new

Put a list of filters into `~/.config/afew/config`:

.. code-block:: ini

    # This is the default filter chain
    [SpamFilter]
    [KillThreadsFilter]
    [ListMailsFilter]
    [ArchiveSentMailsFilter]
    [InboxFilter]

And create a `post-new` hook for notmuch to call afew:

.. code-block:: sh

    $ notmuchdir=path/to/maildir/.notmuch
    $ mkdir -p "$notmuchdir/hooks"
    $ printf > "$notmuchdir/hooks/post-new" '#!/usr/bin/env sh\n$HOME/.local/bin/afew --tag --new\n'
    $ chmod u+x "$notmuchdir/hooks/post-new"

Next Steps
----------

You can:

* add extra :doc:`filters` for more custom filtering
* make use of the :doc:`move_mode` to move your email between folders
* run afew against all your old mail by running `afew --tag --all`
* start :doc:`extending` afew