|
0
|
1 Roundcube Framework
|
|
|
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 REQUIREMENTS
|
|
|
20 ------------
|
|
|
21 PHP Version 5.4 or greater including:
|
|
|
22 - PCRE, DOM, JSON, Session, Sockets, OpenSSL, Mbstring (required)
|
|
|
23 - PHP PDO with driver for either MySQL, PostgreSQL, SQL Server, Oracle or SQLite (required)
|
|
|
24 - Libiconv, Zip, Fileinfo, Intl, Exif (recommended)
|
|
|
25 - LDAP for LDAP addressbook support (optional)
|
|
|
26
|
|
|
27
|
|
|
28 INSTALLATION
|
|
|
29 ------------
|
|
|
30 Copy all files of this directory to your project or install it in the default
|
|
|
31 include_path directory of your webserver. Some classes of the framework require
|
|
|
32 one or multiple of the following [PEAR][pear] libraries:
|
|
|
33
|
|
|
34 - Mail_Mime 1.8.1 or newer
|
|
|
35 - Net_SMTP 1.7.1 or newer
|
|
|
36 - Net_Socket 1.0.12 or newer
|
|
|
37 - Net_IDNA2 0.1.1 or newer
|
|
|
38 - Auth_SASL 1.0.6 or newer
|
|
|
39
|
|
|
40
|
|
|
41 USAGE
|
|
|
42 -----
|
|
|
43 The Roundcube Framework provides a bootstrapping file which registers an
|
|
|
44 autoloader and sets up the environment necessary for the Roundcube classes.
|
|
|
45 In order to make use of the framework, simply include the bootstrap.php file
|
|
|
46 from this directory in your application and start using the classes by simply
|
|
|
47 instantiating them.
|
|
|
48
|
|
|
49 If you wanna use more complex functionality like IMAP access with database
|
|
|
50 caching or plugins, the rcube singleton helps you loading the necessary files:
|
|
|
51
|
|
|
52 ```php
|
|
|
53 <?php
|
|
|
54
|
|
|
55 define('RCUBE_CONFIG_DIR', '<path-to-config-directory>');
|
|
|
56 define('RCUBE_PLUGINS_DIR', '<path-to-roundcube-plugins-directory');
|
|
|
57
|
|
|
58 require_once '<path-to-roundcube-framework/bootstrap.php';
|
|
|
59
|
|
|
60 $rcube = rcube::get_instance(rcube::INIT_WITH_DB | rcube::INIT_WITH_PLUGINS);
|
|
|
61 $imap = $rcube->get_storage();
|
|
|
62
|
|
|
63 // do cool stuff here...
|
|
|
64
|
|
|
65 ?>
|
|
|
66 ```
|
|
|
67
|
|
|
68 LICENSE
|
|
|
69 -------
|
|
|
70 This program is free software: you can redistribute it and/or modify
|
|
|
71 it under the terms of the GNU General Public License (**with exceptions
|
|
|
72 for plugins**) as published by the Free Software Foundation, either
|
|
|
73 version 3 of the License, or (at your option) any later version.
|
|
|
74
|
|
|
75 This program is distributed in the hope that it will be useful,
|
|
|
76 but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
77 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
78 GNU General Public License for more details.
|
|
|
79
|
|
|
80 You should have received a copy of the GNU General Public License
|
|
|
81 along with this program. If not, see [www.gnu.org/licenses/][gpl].
|
|
|
82
|
|
|
83 This file forms part of the Roundcube Webmail Framework for which the
|
|
|
84 following exception is added: Plugins which merely make function calls to the
|
|
|
85 Roundcube Webmail Framework, and for that purpose include it by reference
|
|
|
86 shall not be considered modifications of the software.
|
|
|
87
|
|
|
88 If you wish to use this file in another project or create a modified
|
|
|
89 version that will not be part of the Roundcube Webmail Framework, you
|
|
|
90 may remove the exception above and use this source code under the
|
|
|
91 original version of the license.
|
|
|
92
|
|
|
93 For more details about licensing and the exceptions for skins and plugins
|
|
|
94 see [roundcube.net/license][license]
|
|
|
95
|
|
|
96
|
|
|
97 CONTACT
|
|
|
98 -------
|
|
|
99 For bug reports or feature requests please refer to the tracking system
|
|
|
100 at [Github][githubissues] or subscribe to our mailing list.
|
|
|
101 See [roundcube.net/support][support] for details.
|
|
|
102
|
|
|
103 You're always welcome to send a message to the project admins:
|
|
|
104 hello(at)roundcube(dot)net
|
|
|
105
|
|
|
106
|
|
|
107 [pear]: http://pear.php.net
|
|
|
108 [gpl]: http://www.gnu.org/licenses/
|
|
|
109 [license]: http://roundcube.net/license
|
|
|
110 [support]: http://roundcube.net/support
|
|
|
111 [githubissues]: https://github.com/roundcube/roundcubemail/issues
|
