aboutsummaryrefslogtreecommitdiffstats
path: root/camel/README
blob: 44f93fa6d884545cac245d52c6bf5c08e5223058 (plain) (blame)
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

                                   CAMEL
     

            A generic Messaging Library


                                   ----
                

Introduction:
-------------

Camel will be a generic messaging library. It will evntually support 
the standard messaging system for receiving and sending messages.
It aims at being the backend for the future gnome-mailer system.

The name "camel" stands for ... nothing. Open area of developpement there.
You know, that "bazaar" thing. Maybe could we organize a big contest on
gnome-list to find the best signification :)

Camel draws heacily from JavaMail and the IMAP4rev1 RFC.
people wanting to hack on a provider are recommended to read the JavaMail
API specification but CMC and MAPI are of interest too.

Please, before starting anything, wait for me to finish the abstract classes.
Some parts are not definitive yet.

 
Organization:
-------------

The library is roughly a set of abstract classes, some kind of generic 
"interfaces" (idl interfaces, not java interfaces ). 

Particular implementations are called providers.

Here are the basic objects:

* CamelService : an abstract class representing an access to a server.
Handles the connection and authentication to any server.

* CamelStore (CamelService): A hierarchy  of folders on a server.

* CamelFolder : An object containing messages. A folder is always associated
to a store.

* CamelMessage : An object contained in folders. Is defined by a set of 
attribute and a content. (Attributes are generally: The date it was received,
the sender address, .....) 

* CamelTransport (CamelService): A way to send messages.

....
...