commit | author | age
|
30233b
|
1 |
RoundCube Webmail (http://roundcube.net) |
T |
2 |
|
977a29
|
3 |
|
T |
4 |
ATTENTION |
|
5 |
--------- |
635831
|
6 |
This is just a snapshot of the current SVN repository and is NOT A STABLE |
977a29
|
7 |
version of RoundCube. There have been major changes since the latest release |
T |
8 |
so please read the update instructions carefully. It's not recommended to |
|
9 |
replace an existing installation of RoundCube with this version. Also using |
|
10 |
a separate database or this installation is highly recommended. |
|
11 |
|
|
12 |
|
30233b
|
13 |
Introduction: |
T |
14 |
------------- |
|
15 |
RoundCube Webmail is a browser-based multilingual IMAP client with an |
635831
|
16 |
application-like user interface. It provides full functionality you expect |
T |
17 |
from an e-mail client, including MIME support, address book, folder manipulation, |
|
18 |
message searching and spell checking. RoundCube Webmail is written in PHP and |
|
19 |
requires the MySQL or Postgres database. The user interface is fully skinnable |
|
20 |
using XHTML and CSS 2. |
30233b
|
21 |
|
T |
22 |
This project is meant to be a modern webmail solution which is easy to |
52c1f2
|
23 |
install/configure and that runs on a standard PHP plus MySQL or Postgres |
T |
24 |
configuration. It includes open-source classes/libraries like PEAR |
|
25 |
(http://pear.php.net) and the IMAP wrapper from IlohaMail |
|
26 |
(http://www.ilohamail.org). |
30233b
|
27 |
|
T |
28 |
The current development skin uses icons designed by Stephen Horlander and Kevin |
|
29 |
Gerich for Mozilla.org. |
|
30 |
|
|
31 |
|
f11541
|
32 |
Installation: |
T |
33 |
------------- |
|
34 |
For detailed instructions on how to install RoundCube webmail on your server, |
|
35 |
please refer to the INSTALL document in the same directory as this document. |
|
36 |
|
|
37 |
|
|
38 |
Licensing: |
|
39 |
---------- |
|
40 |
This product is distributed under the GPL. Please read through the file |
|
41 |
LICENSE for more information about our license. |
|
42 |
|
|
43 |
|
52c1f2
|
44 |
How it works: |
T |
45 |
------------- |
|
46 |
The main authority for the RoundCube access is the IMAP server. If |
|
47 |
'auto_create_user' is set to TRUE in config/main.inc.php a new record in the |
|
48 |
user table will be created once the IMAP login succeeded. This user record does |
|
49 |
not store a password, it's just used to assign identities, contacts and cache |
|
50 |
records. If you have 'auto_create_user' set to FALSE only IMAP logins which |
|
51 |
already have a corresponding entry in the user's table (username and hostname) |
|
52 |
will be allowed. |
|
53 |
|
|
54 |
|
a4bafb
|
55 |
Code Layout: |
T |
56 |
------------ |
|
57 |
Basic sequence (index.php): |
f11541
|
58 |
- index.php -> rcmail_load_gui -> new rcmail_template -> rcmail_template::send |
a4bafb
|
59 |
- authentication details in this sequence |
T |
60 |
|
|
61 |
Tasks |
|
62 |
- index.php limits tasks to set list |
|
63 |
- can see task in roundcube link when you mouse over it |
|
64 |
- task templates stored in skins/default/templates |
f11541
|
65 |
- templates "roundcube:" tokens that get replaced in rcmail_template class |
a4bafb
|
66 |
|
T |
67 |
program/include/rcube_shared.inc |
|
68 |
- defines rcube_html_page, class that lays out a roundcube web page |
|
69 |
- defines form control classes |
f11541
|
70 |
- provides common functions |
30233b
|
71 |
|
T |
72 |
|
|
73 |
Contact: |
|
74 |
-------- |
977a29
|
75 |
For any bug reports or feature requests please refer to the tracking system |
635831
|
76 |
at trac.roundcube.net (http://trac.roundcube.net/trac.cgi/report) or |
977a29
|
77 |
subscribe to our mailing list. See http://www.roundcube.net/?p=mailinglists |
T |
78 |
for details. |
30233b
|
79 |
|
977a29
|
80 |
You're always welcome to send a message to the project admin: |
30233b
|
81 |
roundcube@gmail.com |
a0939d
|
82 |
|
S |
83 |
|