README

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