| 1 | Roundcube Webmail |
|---|
| 2 | ================= |
|---|
| 3 | [roundcube.net](http://roundcube.net) |
|---|
| 4 | |
|---|
| 5 | |
|---|
| 6 | ATTENTION |
|---|
| 7 | --------- |
|---|
| 8 | This is just a snapshot of the current SVN repository and is **NOT A STABLE |
|---|
| 9 | version of Roundcube**. It's not recommended to replace an existing installation |
|---|
| 10 | of Roundcube with this version. Also using a separate database for this |
|---|
| 11 | installation is highly recommended. |
|---|
| 12 | |
|---|
| 13 | |
|---|
| 14 | INTRODUCTION |
|---|
| 15 | ------------ |
|---|
| 16 | Roundcube Webmail is a browser-based multilingual IMAP client with an |
|---|
| 17 | application-like user interface. It provides full functionality you expect |
|---|
| 18 | from an email client, including MIME support, address book, folder management, |
|---|
| 19 | message searching and spell checking. Roundcube Webmail is written in PHP and |
|---|
| 20 | requires the MySQL, PostgreSQL or SQLite database. With its plugin API it is |
|---|
| 21 | easily extendable and the user interface is fully customizable using skins |
|---|
| 22 | which are pure XHTML and CSS 2. |
|---|
| 23 | |
|---|
| 24 | The code is mainly written in PHP and is designed to run on a webserver. |
|---|
| 25 | It includes other open-source classes/libraries from [PEAR][pear], |
|---|
| 26 | an IMAP library derived from [IlohaMail][iloha] the [TinyMCE][tinymce] rich |
|---|
| 27 | text editor, [Googiespell][googiespell] library for spell checking or |
|---|
| 28 | the [WASHTML][washtml] sanitizer by Frederic Motte. |
|---|
| 29 | |
|---|
| 30 | The current default skin uses icons designed by Stephen Horlander and [Kevin |
|---|
| 31 | Gerich][kmgerich] for Mozilla.org. |
|---|
| 32 | |
|---|
| 33 | |
|---|
| 34 | INSTALLATION |
|---|
| 35 | ------------ |
|---|
| 36 | For detailed instructions on how to install Roundcube webmail on your server, |
|---|
| 37 | please refer to the INSTALL document in the same directory as this document. |
|---|
| 38 | |
|---|
| 39 | If you're updating an older version of Roundcube please follow the steps |
|---|
| 40 | described in the UPGRADING file. |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | LICENSE |
|---|
| 44 | ------- |
|---|
| 45 | This program is free software: you can redistribute it and/or modify |
|---|
| 46 | it under the terms of the GNU General Public License (**with exceptions |
|---|
| 47 | for skins & plugins**) as published by the Free Software Foundation, |
|---|
| 48 | either version 3 of the License, or (at your option) any later version. |
|---|
| 49 | |
|---|
| 50 | This program is distributed in the hope that it will be useful, |
|---|
| 51 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 52 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 53 | GNU General Public License for more details. |
|---|
| 54 | |
|---|
| 55 | You should have received a copy of the GNU General Public License |
|---|
| 56 | along with this program. If not, see [www.gnu.org/licenses/][gpl]. |
|---|
| 57 | |
|---|
| 58 | This file forms part of the Roundcube Webmail Software for which the |
|---|
| 59 | following exception is added: Plugins and Skins which merely make |
|---|
| 60 | function calls to the Roundcube Webmail Software, and for that purpose |
|---|
| 61 | include it by reference shall not be considered modifications of |
|---|
| 62 | the software. |
|---|
| 63 | |
|---|
| 64 | If you wish to use this file in another project or create a modified |
|---|
| 65 | version that will not be part of the Roundcube Webmail Software, you |
|---|
| 66 | may remove the exception above and use this source code under the |
|---|
| 67 | original version of the license. |
|---|
| 68 | |
|---|
| 69 | For more details about licensing and the exceptions for skins and plugins |
|---|
| 70 | see [roundcube.net/license][license] |
|---|
| 71 | |
|---|
| 72 | |
|---|
| 73 | CONTRIBUTION |
|---|
| 74 | ------------ |
|---|
| 75 | Want to help make Roundcube the best webmail solution ever? |
|---|
| 76 | Roundcube is open source software. Our developers and contributors all |
|---|
| 77 | are volunteers and we're always looking for new additions and resources. |
|---|
| 78 | For more information visit [roundcube.net/contribute][contrib] |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | CONTACT |
|---|
| 82 | ------- |
|---|
| 83 | For any bug reports or feature requests please refer to the tracking system |
|---|
| 84 | at [trac.roundcube.net][tracreport] or subscribe to our mailing list. |
|---|
| 85 | See [roundcube.net/support][support] for details. |
|---|
| 86 | |
|---|
| 87 | You're always welcome to send a message to the project admin: |
|---|
| 88 | hello(at)roundcube(dot)net |
|---|
| 89 | |
|---|
| 90 | |
|---|
| 91 | [pear]: http://pear.php.net |
|---|
| 92 | [iloha]: http://sourceforge.net/projects/ilohamail/ |
|---|
| 93 | [tinymce]: http://www.tinymce.com/ |
|---|
| 94 | [googiespell]: http://orangoo.com/labs/GoogieSpell/ |
|---|
| 95 | [washtml]: http://www.ubixis.com/washtml/ |
|---|
| 96 | [kmgerich]: http://kmgerich.com/ |
|---|
| 97 | [gpl]: http://www.gnu.org/licenses/ |
|---|
| 98 | [license]: http://roundcube.net/license |
|---|
| 99 | [contrib]: http://roundcube.net/contribute |
|---|
| 100 | [support]: http://roundcube.net/support |
|---|
| 101 | [tracreport]: http://trac.roundcube.net/wiki/Howto_ReportIssues |
|---|
