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