Fix bug #2749 “maildir_scan_tree in Maildir++ creates duplicates”
[claws-mail-maildir-plugin.git] / README
1 Maildir++ Plugin for Claws Mail
2
3 B.Sc. Christoph Hohmann
4
5    <reboot@gmx.ch>
6
7    Copyright © 2003-2004 Christoph Hohmann
8      __________________________________________________________
9
10    Table of Contents
11    1. What's the Maildir++ Plugin?
12    2. Requirements
13    3. Install
14    4. Usage
15    5. ToDo
16
17 1. What's the Maildir++ Plugin?
18
19    The Maildir++ plugin for Claws Mail provides direct access to
20    Maildir++ Mailboxes used by IMAP-Servers like Courier-IMAP,
21    BincIMAP or Dovecot without having all the IMAP overhead of a
22    connection to 'localhost'.
23      __________________________________________________________
24
25 2. Requirements
26
27      * Claws Mail 0.9.10claws48
28      * Berkeley DB 4.1
29
30    Newer versions can work too. If you use a precompiled package,
31    you might have to install an additional development-package.
32      __________________________________________________________
33
34 3. Install
35
36    Run the configure script. You need the Claws Mail includes and
37    pkg-config files that are usually installed, when you install
38    Claws Mail.
39
40    After the configure script you can build the plugin with make
41    and install it with make install. It should install plugins in
42    the location where the other plugins are usually
43    $PREFIX/lib/claws-mail. But you can load the plugin from any
44    directory, also from the src/.libs directory in the source
45    directory, if you don't want to install the plugin.
46      __________________________________________________________
47
48 4. Usage
49
50    The Maildir++ plugin consists of 2 parts. A common plugin
51    maildir.so and a Gtk+ plugin maildir_gtk.so. You probably want
52    to load both plugins also the common plugin alone is enough to
53    use a Maildir++ folder that is already added in Sylpheed. But
54    without the Gtk+ plugin you can not add new Maildir++ folders
55    in Sylpheed and the PopUp-menu of the folder tree will only
56    show you the common operations that all folders support and not
57    the operations that affect the Maildir++ folder. So you
58    probably want to load it too.
59
60    After you loaded the plugins you can add an existing or create
61    a new Maildir++ folder with the 'File/Add mailbox/Maildir++'
62    entry in the main menu. After that the folder should appear in
63    the folder tree and is useable just like any other folder.
64      __________________________________________________________
65
66 5. ToDo
67
68    Things that still have to be completed:
69
70      * Automatic updating of folder contents, when changed by
71        other program