README

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