[Core] element index

Package indexes

All elements

_

top

_mkcookie: rcube_session::_mkcookie() in rcube_session.php

Create session cookie from session data
__construct: rcube_spellchecker::__construct() in rcube_spellchecker.php

Constructor
__construct: rcube_user::__construct() in rcube_user.php

Object constructor
__construct: rcube_string_replacer::__construct() in rcube_string_replacer.php
__construct: rcube_session::__construct() in rcube_session.php

Default constructor
__construct: rcube_browser::__construct() in rcube_browser.php
__construct: rcube_config::__construct() in rcube_config.php

Object constructor
__construct: rcube_base_replacer::__construct() in main.inc

a

top

$action: rcmail::$action in rcmail.php

Current action.
abbreviate_string: abbreviate_string() in rcube_shared.inc

Truncate string if it is longer than the allowed length Replace the middle or the ending part of a string with a placeholder
add: rcube_string_replacer::add() in rcube_string_replacer.php

Add a string to the internal list
add_shutdown_function: rcmail::add_shutdown_function() in rcmail.php

Registers shutdown function to be executed on shutdown.
add_word: rcube_spellchecker::add_word() in rcube_spellchecker.php

Add a word to dictionary
all: rcube_config::all() in rcube_config.php

Getter for all config options
array_keys_recursive: array_keys_recursive() in rcube_shared.inc

Get all keys from array (recursive)
asciiwords: asciiwords() in main.inc

Remove all non-ascii and non-word chars
autoselect_host: rcmail::autoselect_host() in rcmail.php

Auto-select IMAP host based on the posted login information

c

top

$comm_path: rcmail::$comm_path in rcmail.php
$config: rcmail::$config in rcmail.php

Stores instance of rcube_config.
callback: rcube_base_replacer::callback() in main.inc
check: rcube_spellchecker::check() in rcube_spellchecker.php

Set content and check spelling
check_auth: rcube_session::check_auth() in rcube_session.php

Check session authentication cookie
check_email: check_email() in main.inc

E-mail address validation
check_request: rcmail::check_request() in rcmail.php

Check if the current request contains a valid token
cleanup: rcube_session::cleanup() in rcube_session.php

Cleanup session data before saving
clear_directory: clear_directory() in rcube_shared.inc

Delete all files within a folder
clisetup.php: clisetup.php in clisetup.php
close: rcube_session::close() in rcube_session.php
console: console() in main.inc

Print or write debug messages
create: rcube_user::create() in rcube_user.php

Create a new user record and return a rcube_user instance
create_attrib_string: create_attrib_string() in main.inc

Compose a valid attribute string for HTML tags

d

top

$data: rcube_user::$data in rcube_user.php
$db: rcmail::$db in rcmail.php

Instace of database class.
db_destroy: rcube_session::db_destroy() in rcube_session.php

Handler for session_destroy()
db_gc: rcube_session::db_gc() in rcube_session.php

Garbage collecting function
db_read: rcube_session::db_read() in rcube_session.php

Read session data from database
db_write: rcube_session::db_write() in rcube_session.php

Save session data.
decrypt: rcmail::decrypt() in rcmail.php

Decrypt 3DES-encrypted string
delete_identity: rcube_user::delete_identity() in rcube_user.php

Mark the given identity as deleted
delete_search: rcube_user::delete_search() in rcube_user.php

Deletes given saved search record
destroy: rcube_session::destroy() in rcube_session.php

Delete session data for the given key

e

top

email2user: rcube_user::email2user() in rcube_user.php

Resolve username using a virtuser plugins
encrypt: rcmail::encrypt() in rcmail.php

Encrypt using 3DES
error: rcube_spellchecker::error() in rcube_spellchecker.php

Returns error message
exec: rcmail::exec() in rcmail.php

Construct shell command, execute it and return output as string.

f

top

format_date: format_date() in main.inc

Convert the given date to a human readable form This uses the date formatting properties from config
format_email_recipient: format_email_recipient() in main.inc

Compose a valid representation of name and e-mail address
found: rcube_spellchecker::found() in rcube_spellchecker.php

Number of mispellings found (after check)

g

top

gc: rcube_session::gc() in rcube_session.php

Execute registered garbage collector routines
get: rcube_spellchecker::get() in rcube_spellchecker.php

Returns checking result (mispelled words with suggestions)
get: rcube_config::get() in rcube_config.php

Getter for a specific config parameter
gettext: rcmail::gettext() in rcmail.php

Get localized text in the desired language
get_action_file: rcmail::get_action_file() in rcmail.php

Returns current action filename
get_address_book: rcmail::get_address_book() in rcmail.php

Return instance of the internal address book class
get_address_sources: rcmail::get_address_sources() in rcmail.php

Return address books list
get_boolean: get_boolean() in rcube_shared.inc

Find out if the string content means TRUE or FALSE
get_cache: rcmail::get_cache() in rcmail.php

Initialize and get cache object
get_crypto_key: rcube_config::get_crypto_key() in rcube_config.php

Return requested DES crypto key.
get_dbh: rcmail::get_dbh() in rcmail.php

Get the current database connection
get_error: rcube_config::get_error() in rcube_config.php

Getter for error state
get_identity: rcube_user::get_identity() in rcube_user.php

Get default identity of this user
get_input_value: get_input_value() in main.inc

Read input value and convert it for internal use Performs stripslashes() and charset conversion if necessary
get_instance: rcmail::get_instance() in rcmail.php

This implements the 'singleton' design pattern
get_ip: rcube_session::get_ip() in rcube_session.php

Getter for remote IP saved with this session
get_keep_alive: rcube_session::get_keep_alive() in rcube_session.php

Getter for keep_alive interval
get_memcache: rcmail::get_memcache() in rcmail.php

Get global handle for memcache access
get_offset_time: get_offset_time() in rcube_shared.inc

Create a unix timestamp with a specified offset from now
get_opt: get_opt() in clisetup.php

Parse commandline arguments into a hash array
get_prefs: rcube_user::get_prefs() in rcube_user.php

Get the preferences saved for this user
get_replacement: rcube_string_replacer::get_replacement() in rcube_string_replacer.php

Build replacement string
get_request_token: rcmail::get_request_token() in rcmail.php

Generate a unique token to be used in a form request
get_search: rcube_user::get_search() in rcube_user.php

Return saved search data.
get_sequence_name: get_sequence_name() in main.inc

Return correct name for a specific database sequence (used for Postgres only)
get_suggestions: rcube_spellchecker::get_suggestions() in rcube_spellchecker.php

Returns suggestions for the specified word
get_table_name: get_table_name() in main.inc

Return correct name for a specific database table
get_timezone: rcube_config::get_timezone() in rcube_config.php

Special getter for user's timezone offset including DST
get_username: rcube_user::get_username() in rcube_user.php

Build a user name string (as e-mail address)
get_words: rcube_spellchecker::get_words() in rcube_spellchecker.php

Returns mispelled words
get_xml: rcube_spellchecker::get_xml() in rcube_spellchecker.php

Returns checking result in XML (Googiespell) format
GOOGLE_HOST: rcube_spellchecker::GOOGLE_HOST in rcube_spellchecker.php
GOOGLE_PORT: rcube_spellchecker::GOOGLE_PORT in rcube_spellchecker.php

h

top

header_delimiter: rcube_config::header_delimiter() in rcube_config.php

Try to autodetect operating system and find the correct line endings
html_identifier: html_identifier() in main.inc

Convert the given string into a valid HTML identifier

i

top

$ID: rcube_user::$ID in rcube_user.php
$imap: rcmail::$imap in rcmail.php

Instance of rcube_imap class.
idn_to_ascii: idn_to_ascii() in rcube_shared.inc
idn_to_utf8: idn_to_utf8() in rcube_shared.inc

intl replacement functions
imageconvert: rcmail::imageconvert() in rcmail.php

Convert an image to a given size and type using imagemagick (ensures input is an image)
imageprops: rcmail::imageprops() in rcmail.php

Use imagemagick or GD lib to read image properties
imap_connect: rcmail::imap_connect() in rcmail.php

Connect to IMAP server with stored session data
imap_init: rcmail::imap_init() in rcmail.php

Create global IMAP object and connect to server
iniset.php: iniset.php in iniset.php
insert_identity: rcube_user::insert_identity() in rcube_user.php

Create a new identity record linked with this user
insert_search: rcube_user::insert_search() in rcube_user.php

Create a new saved search record linked with this user
INSTALL_PATH: INSTALL_PATH in iniset.php
in_array_nocase: in_array_nocase() in rcube_shared.inc

Similar function as in_array() but case-insensitive
is_exception: rcube_spellchecker::is_exception() in rcube_spellchecker.php

Check if the specified word is an exception accoring to spellcheck options.

j

top

JQ: JQ() in main.inc

Quote a given string for javascript output.
json_init: rcmail::json_init() in rcmail.php

Create an output object for JSON responses
json_serialize: json_serialize() in rcube_shared.inc

Convert a variable into a javascript object notation
JS_OBJECT_NAME: JS_OBJECT_NAME in iniset.php

k

top

kill: rcube_session::kill() in rcube_session.php

Kill this session
kill_session: rcmail::kill_session() in rcmail.php

Destroy session data and remove cookie

l

top

$language: rcube_user::$language in rcube_user.php
$link_pattern: rcube_string_replacer::$link_pattern in rcube_string_replacer.php
link_callback: rcube_string_replacer::link_callback() in rcube_string_replacer.php

Callback function used to build HTML links around URL strings
list_identities: rcube_user::list_identities() in rcube_user.php

Return a list of all identities linked with this user
list_languages: rcmail::list_languages() in rcmail.php

Read directory program/localization and return a list of available languages
list_searches: rcube_user::list_searches() in rcube_user.php

Return a list of saved searches linked with this user
load_from_file: rcube_config::load_from_file() in rcube_config.php

Read configuration from a file and merge with the already stored config values
load_gui: rcmail::load_gui() in rcmail.php

Init output object for GUI and add common scripts.
load_language: rcmail::load_language() in rcmail.php

Load a localization package
log: rcube_session::log() in rcube_session.php
login: rcmail::login() in rcmail.php

Perfom login to the IMAP server and to the webmail service.
logout_actions: rcmail::logout_actions() in rcmail.php

Do server side actions on logout

m

top

$mailto_pattern: rcube_string_replacer::$mailto_pattern in rcube_string_replacer.php
$main_tasks: rcmail::$main_tasks in rcmail.php

Main tasks.
$memcache: rcmail::$memcache in rcmail.php

Instace of Memcache class.
mailto_callback: rcube_string_replacer::mailto_callback() in rcube_string_replacer.php

Callback function used to build mailto: links around e-mail strings
mail_domain: rcube_config::mail_domain() in rcube_config.php

Return the mail domain configured for the given host
main.inc: main.inc in main.inc
make_absolute_url: make_absolute_url() in rcube_shared.inc

Convert paths like ../xxx to an absolute path using a base url
MAX_SUGGESTIONS: rcube_spellchecker::MAX_SUGGESTIONS in rcube_spellchecker.php
mb_strlen: mb_strlen() in rcube_shared.inc

mbstring replacement functions
mb_strpos: mb_strpos() in rcube_shared.inc
mb_strrpos: mb_strrpos() in rcube_shared.inc
mb_strtolower: mb_strtolower() in rcube_shared.inc
mb_strtoupper: mb_strtoupper() in rcube_shared.inc
mb_substr: mb_substr() in rcube_shared.inc
mc_destroy: rcube_session::mc_destroy() in rcube_session.php

Handler for session_destroy() with memcache backend
mc_read: rcube_session::mc_read() in rcube_session.php

Read session data from memcache
mc_write: rcube_session::mc_write() in rcube_session.php

Save session data.
memcache_failure: rcmail::memcache_failure() in rcmail.php

Callback for memcache failure
merge: rcube_config::merge() in rcube_config.php

Override config options with the given values (eg. user prefs)

o

top

$output: rcmail::$output in rcmail.php

Instance of rcube_template class.
open: rcube_session::open() in rcube_session.php

p

top

$pattern: rcube_string_replacer::$pattern in rcube_string_replacer.php
$plugins: rcmail::$plugins in rcmail.php

Instance of rcube_plugin_api.
parse_attrib_string: parse_attrib_string() in main.inc

Convert a HTML attribute string attributes to an associative array (name => value)
parse_bytes: parse_bytes() in rcube_shared.inc

Parse a human readable string for a number of bytes
parse_input_value: parse_input_value() in main.inc

Parse/validate input value. See get_input_value() Performs stripslashes() and charset conversion if necessary
parse_url_brackets: rcube_string_replacer::parse_url_brackets() in rcube_string_replacer.php

Fixes bracket characters in URL handling
PATH_SEPARATOR: PATH_SEPARATOR in iniset.php
prompt_silent: prompt_silent() in clisetup.php

from http://blogs.sitepoint.com/2009/05/01/interactive-cli-password-prompt-in-php/

q

top

Q: Q() in main.inc

Quote a given string.
query: rcube_user::query() in rcube_user.php

Find a user record matching the given name and host

r

top

raise_error: raise_error() in main.inc

Throw system error and show error page
rcmail: rcmail in rcmail.php

Application class of Roundcube Webmail implemented as singleton
rcmail.php: rcmail.php in rcmail.php
rcmail_cache_gc: rcmail_cache_gc() in main.inc

Garbage collector for cache entries.
RCMAIL_CHARSET: RCMAIL_CHARSET in iniset.php
RCMAIL_CONFIG_DIR: RCMAIL_CONFIG_DIR in iniset.php
rcmail_deliver_message: rcmail_deliver_message() in main.inc

Send the given message using the configured method
rcmail_display_server_error: rcmail_display_server_error() in main.inc

Outputs error message according to server error/response codes
rcmail_gen_message_id: rcmail_gen_message_id() in main.inc
rcmail_get_edit_field: rcmail_get_edit_field() in main.inc

Create an edit field for inclusion on a form
rcmail_localize_foldername: rcmail_localize_foldername() in main.inc

Try to localize the given IMAP folder name.
rcmail_localize_folderpath: rcmail_localize_folderpath() in main.inc
rcmail_log_login: rcmail_log_login() in main.inc

Write login data (name, ID, IP address) to the 'userlogins' log file.
rcmail_mailbox_list: rcmail_mailbox_list() in main.inc

Return the mailboxlist in HTML
rcmail_mailbox_select: rcmail_mailbox_select() in main.inc

Return the mailboxlist as html_select object
rcmail_mod_css_styles: rcmail_mod_css_styles() in main.inc

Replace all css definitions with #container [def] and remove css-inlined scripting
rcmail_overwrite_action: rcmail_overwrite_action() in main.inc

Overwrite action variable
rcmail_quota_content: rcmail_quota_content() in main.inc
rcmail_quota_display: rcmail_quota_display() in main.inc
rcmail_remote_ip: rcmail_remote_ip() in main.inc

Returns remote IP address and forwarded addresses if found
rcmail_replace_emoticons: rcmail_replace_emoticons() in main.inc

Replaces TinyMCE's emoticon images with plain-text representation
RCMAIL_START: RCMAIL_START in iniset.php
rcmail_temp_gc: rcmail_temp_gc() in main.inc

Garbage collector function for temp files.
rcmail_url: rcmail_url() in main.inc

Compose an URL for a specific action
rcmail_user_date: rcmail_user_date() in main.inc
RCMAIL_VERSION: RCMAIL_VERSION in iniset.php
rcmail_xss_entity_decode: rcmail_xss_entity_decode() in main.inc

Decode escaped entities used by known XSS exploits.
rcmail_xss_entity_decode_callback: rcmail_xss_entity_decode_callback() in main.inc

preg_replace_callback callback for rcmail_xss_entity_decode_callback
rcube_autocomplete_init: rcube_autocomplete_init() in main.inc

Initializes client-side autocompletion
rcube_autoload: rcube_autoload() in iniset.php

Use PHP5 autoload for dynamic class loading
rcube_base_replacer: rcube_base_replacer in main.inc

Helper class to turn relative urls into absolute ones
rcube_browser: rcube_browser in rcube_browser.php

rcube_browser
rcube_browser.php: rcube_browser.php in rcube_browser.php
rcube_charset_convert: rcube_charset_convert() in main.inc

Convert a string from one charset to another.
rcube_check_referer: rcube_check_referer() in main.inc

Check whether the HTTP referer matches the current request
rcube_config: rcube_config in rcube_config.php

Configuration class for Roundcube
rcube_config.php: rcube_config.php in rcube_config.php
rcube_error_handler: rcube_error_handler() in main.inc

Catch an error and throw an exception.
rcube_explode_quoted_string: rcube_explode_quoted_string() in rcube_shared.inc

Explode quoted string
rcube_html_editor: rcube_html_editor() in main.inc

Output HTML editor scripts
rcube_https_check: rcube_https_check() in main.inc

Check if working in SSL mode
rcube_idn_convert: rcube_idn_convert() in main.inc
rcube_idn_to_ascii: rcube_idn_to_ascii() in main.inc
rcube_idn_to_utf8: rcube_idn_to_utf8() in main.inc
RCUBE_INPUT_GET: RCUBE_INPUT_GET in main.inc
RCUBE_INPUT_GPC: RCUBE_INPUT_GPC in main.inc
RCUBE_INPUT_POST: RCUBE_INPUT_POST in main.inc
rcube_label: rcube_label() in main.inc

Get localized text in the desired language It's a global wrapper for rcmail::gettext()
rcube_label_exists: rcube_label_exists() in main.inc

Global wrapper of rcmail::text_exists() to check whether a text label is defined
rcube_log_bug: rcube_log_bug() in main.inc

Report error according to configured debug_level
rcube_mime_struct.php: rcube_mime_struct.php in rcube_mime_struct.php
rcube_parse_charset: rcube_parse_charset() in main.inc

Parse and validate charset name string (see #1485758).
rcube_parse_host: rcube_parse_host() in main.inc

Replaces hostname variables
rcube_pear_error: rcube_pear_error() in iniset.php

Local callback function for PEAR errors
rcube_session: rcube_session in rcube_session.php

Class to provide database supported session storage
rcube_session.php: rcube_session.php in rcube_session.php
rcube_sess_unset: rcube_sess_unset() in main.inc

For backward compatibility.
rcube_shared.inc: rcube_shared.inc in rcube_shared.inc
rcube_spellchecker: rcube_spellchecker in rcube_spellchecker.php

Helper class for spellchecking with Googielspell and PSpell support.
rcube_spellchecker.php: rcube_spellchecker.php in rcube_spellchecker.php
rcube_string_replacer: rcube_string_replacer in rcube_string_replacer.php

Helper class for string replacements based on preg_replace_callback
rcube_string_replacer.php: rcube_string_replacer.php in rcube_string_replacer.php
rcube_strtotime: rcube_strtotime() in main.inc

Improved equivalent to strtotime()
rcube_table_output: rcube_table_output() in main.inc

Create a HTML table based on the given data
rcube_upload_init: rcube_upload_init() in main.inc
rcube_upload_progress: rcube_upload_progress() in main.inc
rcube_user: rcube_user in rcube_user.php

Class representing a system user
rcube_user.php: rcube_user.php in rcube_user.php
rcube_utf7_to_utf8: rcube_utf7_to_utf8() in main.inc

Converts string from standard UTF-7 (RFC 2152) to UTF-8.
rcube_utf16_to_utf8: rcube_utf16_to_utf8() in main.inc

Converts string from UTF-16 to UTF-8 (helper for utf-7 to utf-8 conversion)
rc_detect_encoding: rc_detect_encoding() in rcube_shared.inc

A method to guess encoding of a string.
rc_image_content_type: rc_image_content_type() in rcube_shared.inc

Detect image type of the given binary data by checking magic numbers
rc_mime_content_type: rc_mime_content_type() in rcube_shared.inc

A method to guess the mime_type of an attachment.
rc_request_header: rc_request_header() in rcube_shared.inc

Read a specific HTTP request header
rc_utf8_clean: rc_utf8_clean() in rcube_shared.inc

Removes non-unicode characters from input
rc_wordwrap: rc_wordwrap() in rcube_shared.inc

Wrapper function for wordwrap
regenerate_id: rcube_session::regenerate_id() in rcube_session.php

Generate and set new session id
register_action_map: rcmail::register_action_map() in rcmail.php

Registers action aliases for current task
register_gc_handler: rcube_session::register_gc_handler() in rcube_session.php

Register additional garbage collector functions
remove: rcube_session::remove() in rcube_session.php

Unset a session variable
remove_word: rcube_spellchecker::remove_word() in rcube_spellchecker.php

Remove a word from dictionary
replace_callback: rcube_string_replacer::replace_callback() in rcube_string_replacer.php

Look up the index from the preg_replace matches array and return the substitution value.
rep_specialchars_output: rep_specialchars_output() in main.inc

Replacing specials characters to a specific encoding type
request2param: request2param() in main.inc

Convert array of request parameters (prefixed with _) to a regular array with non-prefixed keys.
reset: rcube_user::reset() in rcube_user.php

Clear the saved object state
resolve: rcube_string_replacer::resolve() in rcube_string_replacer.php

Replace substituted strings with original values

s

top

$session: rcmail::$session in rcmail.php

Instace of rcube_session class.
$smtp: rcmail::$smtp in rcmail.php

Instance of rcube_smtp class.
save_prefs: rcube_user::save_prefs() in rcube_user.php

Write the given user prefs to the user's record
SEARCH_ADDRESSBOOK: rcube_user::SEARCH_ADDRESSBOOK in rcube_user.php
SEARCH_MAIL: rcube_user::SEARCH_MAIL in rcube_user.php
send_future_expire_header: send_future_expire_header() in rcube_shared.inc

Send header with expire date 30 days in future
send_nocacheing_headers: send_nocacheing_headers() in rcube_shared.inc

Send HTTP headers to prevent caching this page
session_configure: rcmail::session_configure() in rcmail.php

Configure session object internals
session_init: rcmail::session_init() in rcmail.php

Create session object and start the session.
set: rcube_config::set() in rcube_config.php

Setter for a config parameter
setcookie: rcmail::setcookie() in rcmail.php

Helper method to set a cookie with the current path and host settings
set_auth_cookie: rcube_session::set_auth_cookie() in rcube_session.php

Set session authentication cookie
set_cookiename: rcube_session::set_cookiename() in rcube_session.php

Setter for the cookie name used for session cookie
set_default: rcube_user::set_default() in rcube_user.php

Make this identity the default one for this user
set_imap_prop: rcmail::set_imap_prop() in rcmail.php

Set root dir and last stored mailbox
set_ip_check: rcube_session::set_ip_check() in rcube_session.php

Enable/disable IP check
set_keep_alive: rcube_session::set_keep_alive() in rcube_session.php

Setter for keep_alive interval
set_lifetime: rcube_session::set_lifetime() in rcube_session.php

Setter for session lifetime
set_secret: rcube_session::set_secret() in rcube_session.php

Setter for cookie encryption secret
set_task: rcmail::set_task() in rcmail.php

Setter for application task
set_user: rcmail::set_user() in rcmail.php

Setter for system user object
set_user_prefs: rcube_config::set_user_prefs() in rcube_config.php

Merge the given prefs over the current config and make sure that they survive further merging.
show_bytes: show_bytes() in rcube_shared.inc

Create a human readable string for a number of bytes
shutdown: rcmail::shutdown() in rcmail.php

Function to be executed in script shutdown
slashify: slashify() in rcube_shared.inc

Make sure the string ends with a slash
smtp_init: rcmail::smtp_init() in rcmail.php

Create SMTP object and connect to server
strip_newlines: strip_newlines() in main.inc

Remove new lines characters from given string
strip_quotes: strip_quotes() in main.inc

Remove single and double quotes from given string

t

top

$task: rcmail::$task in rcmail.php

Current task.
text_exists: rcmail::text_exists() in rcmail.php

Check if the given text label exists
touch: rcube_user::touch() in rcube_user.php

Update user's last_login timestamp

u

top

$user: rcmail::$user in rcmail.php

Stores rcube_user instance.
unslashify: unslashify() in rcube_shared.inc

Remove slash at the end of the string
update_identity: rcube_user::update_identity() in rcube_user.php

Update a specific identity record
url: rcmail::url() in rcmail.php

Build a valid URL to this instance of Roundcube
user2email: rcube_user::user2email() in rcube_user.php

Resolve e-mail address from virtuser plugins

w

top

write_log: write_log() in main.inc

Append a line to a logfile in the logs directory.