You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
roundcubemail/program/lib/Roundcube
Aleksander Machniak 7ebed11b05 More improvements to format=flowed handling + fix in wordwrap() used internally by format_flowed() 12 years ago
..
README.md Add github syntax highlighting to php code snippet 12 years ago
bootstrap.php Welcome to 2013 12 years ago
html.php CS fixes 12 years ago
rcube.php Improve charset detection by prioritizing charset according to user language (#1485669) 12 years ago
rcube_addressbook.php Fix typo 12 years ago
rcube_base_replacer.php Cleanup, remove file paths from doc 12 years ago
rcube_browser.php Cleanup, remove file paths from doc 12 years ago
rcube_cache.php Cleanup, remove file paths from doc 12 years ago
rcube_charset.php Improve charset detection by prioritizing charset according to user language (#1485669) 12 years ago
rcube_config.php Cleanup, remove file paths from doc 12 years ago
rcube_contacts.php Rename $date_types -> $date_cols 12 years ago
rcube_content_filter.php Cleanup, remove file paths from doc 12 years ago
rcube_csv2vcard.php Support more Thunderbird CSV fields, added zh_TW localization for csv2vcard map (#1488901) 12 years ago
rcube_db.php Reset $db_error_msg on query 12 years ago
rcube_db_mssql.php Cleanup, remove file paths from doc 12 years ago
rcube_db_mysql.php Force autocommit mode in mysql database driver (#1488902) 12 years ago
rcube_db_pgsql.php Cleanup, remove file paths from doc 12 years ago
rcube_db_sqlite.php Fix Call to undefined method rcube_db_sqlite::_get_result() 12 years ago
rcube_db_sqlsrv.php Cleanup, remove file paths from doc 12 years ago
rcube_enriched.php Cleanup, remove file paths from doc 12 years ago
rcube_html2text.php Framework'ize html2text class 12 years ago
rcube_image.php Better GD module functions detection, should fix "Call to undefined function imagecreatefromjpeg()" error 12 years ago
rcube_imap.php Cleanup, remove file paths from doc 12 years ago
rcube_imap_cache.php Cleanup, remove file paths from doc 12 years ago
rcube_imap_generic.php Workaround UW-IMAP bug where hierarchy separator is added to the shared folder name (#1488879) 12 years ago
rcube_ldap.php Fix searching by date in address book (#1488888) 12 years ago
rcube_message.php Don't rely on Subject header only 12 years ago
rcube_message_header.php Cleanup, remove file paths from doc 12 years ago
rcube_message_part.php Cleanup, remove file paths from doc 12 years ago
rcube_mime.php More improvements to format=flowed handling + fix in wordwrap() used internally by format_flowed() 12 years ago
rcube_output.php Cleanup, remove file paths from doc 12 years ago
rcube_plugin.php CS fixes 12 years ago
rcube_plugin_api.php CS fixes 12 years ago
rcube_result_index.php Cleanup, remove file paths from doc 12 years ago
rcube_result_set.php Cleanup, remove file paths from doc 12 years ago
rcube_result_thread.php Cleanup, remove file paths from doc 12 years ago
rcube_session.php CS fixes 12 years ago
rcube_smtp.php Add option to use envelope From address for MDN responses (#1488880) 12 years ago
rcube_spellchecker.php Framework'ize html2text class 12 years ago
rcube_storage.php Display 'Sender' header in message preview 12 years ago
rcube_string_replacer.php Don't convert to link a text with < and > characters 12 years ago
rcube_user.php Cleanup, remove file paths from doc 12 years ago
rcube_utils.php Cleanup, remove file paths from doc 12 years ago
rcube_vcard.php Fix handling of escaped separator in vCard file (#1488896) 12 years ago
rcube_washtml.php Move washtml class into Roundcube Framework (rcube_washtml), add some improvements 12 years ago

README.md

Roundcube Framework

INTRODUCTION

The Roundcube Framework is the basic library used for the Roundcube Webmail application. It is an extract of classes providing the core functionality for an email system. They can be used individually or as package for the following tasks:

  • IMAP mailbox access with optional caching
  • MIME message handling
  • Email message creation and sending through SMTP
  • General caching utilities using the local database
  • Database abstraction using PDO
  • VCard parsing and writing

INSTALLATION

Copy all files of this directory to your project or install it in the default include_path directory of your webserver. Some classes of the framework require one or multiple of the following PEAR libraries:

USAGE

The Roundcube Framework provides a bootstrapping file which registers an autoloader and sets up the environment necessary for the Roundcube classes. In order to make use of the framework, simply include the bootstrap.php file from this directory in your application and start using the classes by simply instantiating them.

If you wanna use more complex functionality like IMAP access with database caching or plugins, the rcube singleton helps you loading the necessary files:

<?php

define('RCUBE_CONFIG_DIR',  '<path-to-config-directory>');
define('RCUBE_PLUGINS_DIR', '<path-to-roundcube-plugins-directory');

require_once '<path-to-roundcube-framework/bootstrap.php';

$rcube = rcube::get_instance(rcube::INIT_WITH_DB | rcube::INIT_WITH_PLUGINS);
$imap = $rcube->get_storage();

// do cool stuff here...

?>

LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License (with exceptions for plugins) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see www.gnu.org/licenses/.

This file forms part of the Roundcube Webmail Framework for which the following exception is added: Plugins which merely make function calls to the Roundcube Webmail Framework, and for that purpose include it by reference shall not be considered modifications of the software.

If you wish to use this file in another project or create a modified version that will not be part of the Roundcube Webmail Framework, you may remove the exception above and use this source code under the original version of the license.

For more details about licensing and the exceptions for skins and plugins see roundcube.net/license

CONTACT

For any bug reports or feature requests please refer to the tracking system at trac.roundcube.net or subscribe to our mailing list. See roundcube.net/support for details.

You're always welcome to send a message to the project admins: hello(at)roundcube(dot)net