| commit | author | age | ||
| bc1ec6 | 1 | Roundcube Framework |
| TB | 2 | =================== |
| 3 | ||
| 4 | INTRODUCTION | |
| 5 | ------------ | |
| 6 | The Roundcube Framework is the basic library used for the Roundcube Webmail | |
| 7 | application. It is an extract of classes providing the core functionality for | |
| 8 | an email system. They can be used individually or as package for the following | |
| 9 | tasks: | |
| 10 | ||
| 11 | - IMAP mailbox access with optional caching | |
| 12 | - MIME message handling | |
| 13 | - Email message creation and sending through SMTP | |
| 14 | - General caching utilities using the local database | |
| 15 | - Database abstraction using PDO | |
| 16 | - VCard parsing and writing | |
| 17 | ||
| 18 | ||
| 19 | INSTALLATION | |
| 20 | ------------ | |
| 21 | Copy all files of this directory to your project or install it in the default | |
| 22 | include_path directory of your webserver. Some classes of the framework require | |
| 23 | one or multiple of the following [PEAR][pear] libraries: | |
| 24 | ||
| 25 | - Mail_Mime 1.8.1 or newer | |
| d4df37 | 26 | - Net_SMTP 1.7.1 or newer |
| AM | 27 | - Net_Socket 1.0.12 or newer |
| bc1ec6 | 28 | - Net_IDNA2 0.1.1 or newer |
| TB | 29 | - Auth_SASL 1.0.6 or newer |
| 30 | ||
| 31 | ||
| 32 | USAGE | |
| 33 | ----- | |
| 34 | The Roundcube Framework provides a bootstrapping file which registers an | |
| 35 | autoloader and sets up the environment necessary for the Roundcube classes. | |
| 36 | In order to make use of the framework, simply include the bootstrap.php file | |
| 37 | from this directory in your application and start using the classes by simply | |
| 38 | instantiating them. | |
| 39 | ||
| 40 | If you wanna use more complex functionality like IMAP access with database | |
| 41 | caching or plugins, the rcube singleton helps you loading the necessary files: | |
| 42 | ||
| d414cc | 43 | ```php |
| bc1ec6 | 44 | <?php |
| TB | 45 | |
| 46 | define('RCUBE_CONFIG_DIR', '<path-to-config-directory>'); | |
| 47 | define('RCUBE_PLUGINS_DIR', '<path-to-roundcube-plugins-directory'); | |
| 48 | ||
| 49 | require_once '<path-to-roundcube-framework/bootstrap.php'; | |
| 50 | ||
| 51 | $rcube = rcube::get_instance(rcube::INIT_WITH_DB | rcube::INIT_WITH_PLUGINS); | |
| 52 | $imap = $rcube->get_storage(); | |
| 53 | ||
| 54 | // do cool stuff here... | |
| 55 | ||
| 56 | ?> | |
| d414cc | 57 | ``` |
| bc1ec6 | 58 | |
| TB | 59 | LICENSE |
| 60 | ------- | |
| 61 | This program is free software: you can redistribute it and/or modify | |
| 62 | it under the terms of the GNU General Public License (**with exceptions | |
| 63 | for plugins**) as published by the Free Software Foundation, either | |
| 64 | version 3 of the License, or (at your option) any later version. | |
| 65 | ||
| 66 | This program is distributed in the hope that it will be useful, | |
| 67 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 68 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 69 | GNU General Public License for more details. | |
| 70 | ||
| 71 | You should have received a copy of the GNU General Public License | |
| 72 | along with this program. If not, see [www.gnu.org/licenses/][gpl]. | |
| 73 | ||
| 74 | This file forms part of the Roundcube Webmail Framework for which the | |
| 75 | following exception is added: Plugins which merely make function calls to the | |
| 76 | Roundcube Webmail Framework, and for that purpose include it by reference | |
| 77 | shall not be considered modifications of the software. | |
| 78 | ||
| 79 | If you wish to use this file in another project or create a modified | |
| 80 | version that will not be part of the Roundcube Webmail Framework, you | |
| 81 | may remove the exception above and use this source code under the | |
| 82 | original version of the license. | |
| 83 | ||
| 84 | For more details about licensing and the exceptions for skins and plugins | |
| 85 | see [roundcube.net/license][license] | |
| 86 | ||
| 87 | ||
| 88 | CONTACT | |
| 89 | ------- | |
| 90 | For any bug reports or feature requests please refer to the tracking system | |
| 91 | at [trac.roundcube.net][tracreport] or subscribe to our mailing list. | |
| 92 | See [roundcube.net/support][support] for details. | |
| 93 | ||
| 94 | You're always welcome to send a message to the project admins: | |
| 95 | hello(at)roundcube(dot)net | |
| 96 | ||
| 97 | ||
| 98 | [pear]: http://pear.php.net | |
| 99 | [gpl]: http://www.gnu.org/licenses/ | |
| 100 | [license]: http://roundcube.net/license | |
| 101 | [support]: http://roundcube.net/support | |
| 102 | [tracreport]: http://trac.roundcube.net/wiki/Howto_ReportIssues | |
