README


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
72
73
74
75
76
77
78
79
80
81
82

RoundCube Webmail (http://roundcube.net)


ATTENTION
---------
This is just a snapshot of the current CVS repository and is NOT A STABLE
version of RoundCube. There have been major changes since the latest release
so please read the update instructions carefully. It's not recommended to
replace an existing installation of RoundCube with this version. Also using
a separate database or this installation is highly recommended.


Introduction:
-------------
RoundCube Webmail is a browser-based multilingual IMAP client with an
application-like user interface. It provides full functionality you expect from
an e-mail client, including MIME support, address book, folder manipulation and
message filters. RoundCube Webmail is written in PHP and requires the MySQL
database. The user interface is fully skinnable using XHTML and CSS 2.

This project is meant to be a modern webmail solution which is easy to
install/configure and that runs on a standard PHP plus MySQL or Postgres
configuration. It includes open-source classes/libraries like PEAR
(http://pear.php.net) and the IMAP wrapper from IlohaMail
(http://www.ilohamail.org).

The current development skin uses icons designed by Stephen Horlander and Kevin 
Gerich for Mozilla.org.


How it works:
-------------
The main authority for the RoundCube access is the IMAP server. If
'auto_create_user' is set to TRUE in config/main.inc.php a new record in the
user table will be created once the IMAP login succeeded. This user record does
not store a password, it's just used to assign identities, contacts and cache
records. If you have 'auto_create_user' set to FALSE only IMAP logins which
already have a corresponding entry in the user's table (username and hostname)
will be allowed.


Code Layout:
------------

Basic sequence (index.php):
  - index.php -> load_gui -> parse_template
  - authentication details in this sequence

Tasks
  - index.php limits tasks to set list
  - can see task in roundcube link when you mouse over it
  - task templates stored in skins/default/templates
  - templates "roundcube:" tokens that get replaced in parse_template

program/include/rcube_shared.inc
  - defines rcube_html_page, class that lays out a roundcube web page
  - defines form control classes


Installation:
-------------
For detailed instructions on how to install RoundCube webmail on your server,
please refer to the INSTALL document in the same directory as this document.


Licensing: 
----------
This product is distributed under the GPL. Please read through the file
LICENSE for more information about our license.


Contact:
--------
For any bug reports or feature requests please refer to the tracking system
at sourceforge.net (http://sourceforge.net/tracker/?group_id=139281) or 
subscribe to our mailing list. See http://www.roundcube.net/?p=mailinglists
for details.

You're always welcome to send a message to the project admin:
roundcube@gmail.com