From 2f2f15b7aabe19e45dad9bddb7eb7f4394aa1e21 Mon Sep 17 00:00:00 2001 From: thomascube <thomas@roundcube.net> Date: Mon, 04 Sep 2006 08:26:30 -0400 Subject: [PATCH] Little improvements for message parsing and encoding --- README | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 files changed, 51 insertions(+), 6 deletions(-) diff --git a/README b/README index 67e7e70..e8e065e 100644 --- a/README +++ b/README @@ -1,5 +1,15 @@ 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 @@ -9,17 +19,47 @@ 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). +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 SquirrelMail on your server, +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. @@ -31,7 +71,12 @@ 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. +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. -Your also welcome to send a message to the project admin: +You're always welcome to send a message to the project admin: roundcube@gmail.com + + -- Gitblit v1.9.1