thomascube
2012-01-27 77c779a2b807cdde0641267f272517738157edf4
README
@@ -1,83 +1,86 @@
RoundCube Webmail (http://roundcube.net)
Roundcube Webmail (http://roundcube.net)
ATTENTION
---------
This is just a snapshot of the current SVN repository and is NOT A STABLE
version of RoundCube. Unlike the latest release this version requires PHP 5
and does not work on a webserver with PHP 4. 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.
version of Roundcube. It's not recommended to replace an existing installation
of Roundcube with this version. Also using a separate database for this
installation is highly recommended.
Introduction:
-------------
RoundCube Webmail is a browser-based multilingual IMAP client with an
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,
message searching and spell checking. RoundCube Webmail is written in PHP and
requires the MySQL or Postgres database. The user interface is fully skinnable
using XHTML and CSS 2.
from an e-mail client, including MIME support, address book, folder management,
message searching and spell checking. Roundcube Webmail is written in PHP and
requires the MySQL, PostgreSQL or SQLite database. With its plugin API it is
easily extendable and the user interface is fully customizable using skins
which are pure 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).
This project includes other open-source classes/libraries from PEAR
(http://pear.php.net), an IMAP library derived from IlohaMail
the TinyMCE rich text editor, Googiespell library for spell checking
or the HTML sanitizer by Frederic Motte.
The current development skin uses icons designed by Stephen Horlander and Kevin
The current default skin uses icons designed by Stephen Horlander and Kevin
Gerich for Mozilla.org.
Installation:
-------------
For detailed instructions on how to install RoundCube webmail on your server,
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.
If you're updating an older version of Roundcube please follow the steps
described in the UPGRADING file.
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.
LICENSING
---------
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License (with exceptions
for skins & plugins) as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see http://www.gnu.org/licenses/.
This file forms part of the Roundcube Webmail Software for which the
following exception is added: Plugins and Skins which merely make
function calls to the Roundcube Webmail Software, and for that purpose
include it by reference shall not be considered modifications of
the software.
If you wish to use this file in another project or create a modified
version that will not be part of the Roundcube Webmail Software, you
may remove the exception above and use this source code under the
original version of the license.
For more details about licensing and the expections for skins and plugins
see http://roundcube.net/license
Code Layout:
CONTRIBUTION
------------
Basic sequence (index.php):
  - index.php -> rcmail_load_gui -> new rcmail_template -> rcmail_template::send
  - 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 rcmail_template class
program/include/rcube_shared.inc
  - defines rcube_html_page, class that lays out a roundcube web page
  - defines form control classes
  - provides common functions
Want to help make Roundcube the best webmail solution ever?
Roundcube is open source software. Our developers and contributors all
are volunteers and we're always looking for new additions and resources.
For more information visit http://roundcube.net/contribute
Contact:
--------
CONTACT
-------
For any bug reports or feature requests please refer to the tracking system
at trac.roundcube.net (http://trac.roundcube.net/wiki/Howto_ReportIssues) or
subscribe to our mailing list. See http://roundcube.net/support
at trac.roundcube.net (http://trac.roundcube.net/wiki/Howto_ReportIssues)
or  subscribe to our mailing list. See http://roundcube.net/support
for details.
You're always welcome to send a message to the project admin:
hello@roundcube.net