|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 22-Nov-2021 | - |
| cache/ | H | 22-Nov-2021 | - | 1,061 | 540 |
| db/ | H | 22-Nov-2021 | - | 1,711 | 991 |
| session/ | H | 22-Nov-2021 | - | 913 | 401 |
| spellchecker/ | H | 22-Nov-2021 | - | 853 | 483 |
| README.md | H A D | 22-Nov-2021 | 3.7 KiB | 106 | 79 |
| bootstrap.php | H A D | 22-Nov-2021 | 11.7 KiB | 446 | 236 |
| html.php | H A D | 22-Nov-2021 | 28.9 KiB | 1,038 | 521 |
| rcube.php | H A D | 22-Nov-2021 | 55.6 KiB | 1,843 | 1,057 |
| rcube_addressbook.php | H A D | 22-Nov-2021 | 30.7 KiB | 891 | 354 |
| rcube_addresses.php | H A D | 22-Nov-2021 | 13.2 KiB | 413 | 236 |
| rcube_base_replacer.php | H A D | 22-Nov-2021 | 3.6 KiB | 124 | 53 |
| rcube_browser.php | H A D | 22-Nov-2021 | 4.1 KiB | 104 | 45 |
| rcube_cache.php | H A D | 22-Nov-2021 | 18.9 KiB | 639 | 339 |
| rcube_charset.php | H A D | 22-Nov-2021 | 22.6 KiB | 559 | 364 |
| rcube_config.php | H A D | 22-Nov-2021 | 31.8 KiB | 943 | 606 |
| rcube_contacts.php | H A D | 22-Nov-2021 | 35.2 KiB | 1,096 | 683 |
| rcube_content_filter.php | H A D | 22-Nov-2021 | 2 KiB | 59 | 26 |
| rcube_csv2vcard.php | H A D | 22-Nov-2021 | 24.6 KiB | 696 | 463 |
| rcube_db.php | H A D | 22-Nov-2021 | 43.5 KiB | 1,502 | 808 |
| rcube_enriched.php | H A D | 22-Nov-2021 | 5.3 KiB | 161 | 103 |
| rcube_html2text.php | H A D | 22-Nov-2021 | 24.8 KiB | 750 | 357 |
| rcube_image.php | H A D | 22-Nov-2021 | 17.7 KiB | 515 | 326 |
| rcube_imap.php | H A D | 22-Nov-2021 | 148.2 KiB | 4,649 | 2,710 |
| rcube_imap_cache.php | H A D | 22-Nov-2021 | 39.1 KiB | 1,264 | 763 |
| rcube_imap_generic.php | H A D | 22-Nov-2021 | 132.9 KiB | 4,181 | 2,598 |
| rcube_imap_search.php | H A D | 22-Nov-2021 | 8.9 KiB | 283 | 133 |
| rcube_ldap.php | H A D | 22-Nov-2021 | 79.4 KiB | 2,277 | 1,487 |
| rcube_ldap_generic.php | H A D | 22-Nov-2021 | 9.6 KiB | 357 | 190 |
| rcube_message.php | H A D | 03-May-2022 | 46 KiB | 1,253 | 768 |
| rcube_message_header.php | H A D | 22-Nov-2021 | 7.3 KiB | 339 | 108 |
| rcube_message_part.php | H A D | 22-Nov-2021 | 2.6 KiB | 110 | 30 |
| rcube_mime.php | H A D | 22-Nov-2021 | 33.4 KiB | 993 | 618 |
| rcube_mime_decode.php | H A D | 22-Nov-2021 | 14.5 KiB | 426 | 238 |
| rcube_output.php | H A D | 22-Nov-2021 | 12.1 KiB | 389 | 200 |
| rcube_plugin.php | H A D | 22-Nov-2021 | 13.3 KiB | 448 | 185 |
| rcube_plugin_api.php | H A D | 22-Nov-2021 | 27.7 KiB | 803 | 505 |
| rcube_result_index.php | H A D | 22-Nov-2021 | 12.9 KiB | 447 | 250 |
| rcube_result_multifolder.php | H A D | 22-Nov-2021 | 9.8 KiB | 370 | 178 |
| rcube_result_set.php | H A D | 22-Nov-2021 | 3.7 KiB | 143 | 75 |
| rcube_result_thread.php | H A D | 22-Nov-2021 | 20.9 KiB | 700 | 424 |
| rcube_session.php | H A D | 22-Nov-2021 | 21.1 KiB | 750 | 442 |
| rcube_smtp.php | H A D | 22-Nov-2021 | 20.6 KiB | 589 | 370 |
| rcube_spellchecker.php | H A D | 22-Nov-2021 | 12.6 KiB | 433 | 261 |
| rcube_spoofchecker.php | H A D | 22-Nov-2021 | 2.5 KiB | 68 | 23 |
| rcube_storage.php | H A D | 22-Nov-2021 | 30 KiB | 1,016 | 240 |
| rcube_string_replacer.php | H A D | 22-Nov-2021 | 11.1 KiB | 342 | 248 |
| rcube_text2html.php | H A D | 22-Nov-2021 | 10.4 KiB | 324 | 182 |
| rcube_tnef_decoder.php | H A D | 22-Nov-2021 | 27.4 KiB | 798 | 551 |
| rcube_user.php | H A D | 22-Nov-2021 | 27.2 KiB | 892 | 541 |
| rcube_utils.php | H A D | 22-Nov-2021 | 54 KiB | 1,649 | 925 |
| rcube_vcard.php | H A D | 22-Nov-2021 | 33.4 KiB | 991 | 644 |
| rcube_washtml.php | H A D | 22-Nov-2021 | 39.2 KiB | 1,015 | 597 |
README.md
1Roundcube Framework
2===================
3
4INTRODUCTION
5------------
6The Roundcube Framework is the basic library used for the Roundcube Webmail
7application. It is an extract of classes providing the core functionality for
8an email system. They can be used individually or as package for the following
9tasks:
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
19REQUIREMENTS
20------------
21PHP Version 5.5 or greater including:
22 - PCRE, DOM, JSON, Session, Sockets, OpenSSL, Mbstring, Filter, Ctype, Intl (required)
23 - PHP PDO with driver for either MySQL, PostgreSQL, SQL Server, Oracle or SQLite (required)
24 - Iconv, Zip, Fileinfo, Exif (recommended)
25 - LDAP for LDAP addressbook support (optional)
26
27
28INSTALLATION
29------------
30Copy all files of this directory to your project or install it in the default
31include_path directory of your webserver. Some classes of the framework require
32external libraries. See composer.json-dist for the list of required packages.
33
34
35USAGE
36-----
37The Roundcube Framework provides a bootstrapping file which registers an
38autoloader and sets up the environment necessary for the Roundcube classes.
39In order to make use of the framework, simply include the bootstrap.php file
40from this directory in your application and start using the classes by simply
41instantiating them.
42
43If you wanna use more complex functionality like IMAP access with database
44caching or plugins, the rcube singleton helps you loading the necessary files:
45
46```php
47<?php
48
49define('RCUBE_CONFIG_DIR', '<path-to-config-directory>');
50define('RCUBE_PLUGINS_DIR', '<path-to-roundcube-plugins-directory');
51
52require_once '<path-to-roundcube-framework/bootstrap.php';
53
54$rcube = rcube::get_instance(rcube::INIT_WITH_DB | rcube::INIT_WITH_PLUGINS);
55$imap = $rcube->get_storage();
56
57// do cool stuff here...
58
59?>
60```
61
62LICENSE
63-------
64This program is free software: you can redistribute it and/or modify
65it under the terms of the GNU General Public License (**with exceptions
66for plugins**) as published by the Free Software Foundation, either
67version 3 of the License, or (at your option) any later version.
68
69This program is distributed in the hope that it will be useful,
70but WITHOUT ANY WARRANTY; without even the implied warranty of
71MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
72GNU General Public License for more details.
73
74You should have received a copy of the GNU General Public License
75along with this program. If not, see [www.gnu.org/licenses/][gpl].
76
77This file forms part of the Roundcube Webmail Framework for which the
78following exception is added: Plugins which merely make function calls to the
79Roundcube Webmail Framework, and for that purpose include it by reference
80shall not be considered modifications of the software.
81
82If you wish to use this file in another project or create a modified
83version that will not be part of the Roundcube Webmail Framework, you
84may remove the exception above and use this source code under the
85original version of the license.
86
87For more details about licensing and the exceptions for skins and plugins
88see [roundcube.net/license][license]
89
90
91CONTACT
92-------
93For bug reports or feature requests please refer to the tracking system
94at [Github][githubissues] or subscribe to our mailing list.
95See [roundcube.net/support][support] for details.
96
97You're always welcome to send a message to the project admins:
98hello(at)roundcube(dot)net
99
100
101[pear]: http://pear.php.net
102[gpl]: http://www.gnu.org/licenses/
103[license]: http://roundcube.net/license
104[support]: http://roundcube.net/support
105[githubissues]: https://github.com/roundcube/roundcubemail/issues
106