annotate README.md @ 20:4aec5e272733

missed earlier?
author Charlie Root
date Wed, 08 Oct 2025 09:42:21 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
1 Roundcube Webmail
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
2 =================
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
3 [roundcube.net](http://roundcube.net)
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
4
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
5 [![Build Status](https://api.travis-ci.org/roundcube/roundcubemail.svg?branch=release-1.3)](https://travis-ci.org/roundcube/roundcubemail)
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
6
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
7
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
8 INTRODUCTION
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
9 ------------
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
10 Roundcube Webmail is a browser-based multilingual IMAP client with an
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
11 application-like user interface. It provides full functionality you expect
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
12 from an email client, including MIME support, address book, folder management,
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
13 message searching and spell checking. Roundcube Webmail is written in PHP and
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
14 requires the MySQL, PostgreSQL or SQLite database. With its plugin API it is
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
15 easily extendable and the user interface is fully customizable using skins
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
16 which are pure XHTML and CSS 2.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
17
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
18 The code is mainly written in PHP and is designed to run on a webserver.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
19 It includes other open-source classes/libraries from [PEAR][pear],
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
20 an IMAP library derived from [IlohaMail][iloha] the [TinyMCE][tinymce] rich
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
21 text editor, [Googiespell][googiespell] library for spell checking or
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
22 the [WASHTML][washtml] sanitizer by Frederic Motte.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
23
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
24 The current default skin 'Larry' was kindly created by FLINT / Büro für
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
25 Gestaltung, Berne, Switzerland.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
26
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
27
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
28 INSTALLATION
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
29 ------------
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
30 For detailed instructions on how to install Roundcube webmail on your server,
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
31 please refer to the INSTALL document in the same directory as this document.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
32
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
33 If you're updating an older version of Roundcube please follow the steps
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
34 described in the UPGRADING file.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
35
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
36
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
37 LICENSE
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
38 -------
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
39 This program is free software: you can redistribute it and/or modify
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
40 it under the terms of the GNU General Public License (**with exceptions
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
41 for skins & plugins**) as published by the Free Software Foundation,
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
42 either version 3 of the License, or (at your option) any later version.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
43
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
44 This program is distributed in the hope that it will be useful,
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
45 but WITHOUT ANY WARRANTY; without even the implied warranty of
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
46 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
47 GNU General Public License for more details.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
48
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
49 You should have received a copy of the GNU General Public License
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
50 along with this program. If not, see [www.gnu.org/licenses/][gpl].
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
51
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
52 This file forms part of the Roundcube Webmail Software for which the
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
53 following exception is added: Plugins and Skins which merely make
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
54 function calls to the Roundcube Webmail Software, and for that purpose
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
55 include it by reference shall not be considered modifications of
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
56 the software.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
57
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
58 If you wish to use this file in another project or create a modified
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
59 version that will not be part of the Roundcube Webmail Software, you
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
60 may remove the exception above and use this source code under the
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
61 original version of the license.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
62
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
63 For more details about licensing and the exceptions for skins and plugins
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
64 see [roundcube.net/license][license]
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
65
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
66
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
67 CONTRIBUTION
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
68 ------------
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
69 Want to help make Roundcube the best webmail solution ever?
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
70 Roundcube is open source software. Our developers and contributors all
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
71 are volunteers and we're always looking for new additions and resources.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
72 For more information visit [roundcube.net/contribute][contrib]
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
73
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
74
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
75 CONTACT
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
76 -------
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
77 For bug reports or feature requests please refer to the tracking system
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
78 at [Github][githubissues] or subscribe to our mailing list.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
79 See [roundcube.net/support][support] for details.
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
80
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
81 You're always welcome to send a message to the project admin:
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
82 hello(at)roundcube(dot)net
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
83
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
84
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
85 [pear]: http://pear.php.net
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
86 [iloha]: http://sourceforge.net/projects/ilohamail/
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
87 [tinymce]: http://www.tinymce.com/
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
88 [googiespell]: http://orangoo.com/labs/GoogieSpell/
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
89 [washtml]: http://www.ubixis.com/washtml/
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
90 [kmgerich]: http://kmgerich.com/
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
91 [gpl]: http://www.gnu.org/licenses/
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
92 [license]: http://roundcube.net/license
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
93 [contrib]: http://roundcube.net/contribute
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
94 [support]: http://roundcube.net/support
4aec5e272733 missed earlier?
Charlie Root
parents:
diff changeset
95 [githubissues]: https://github.com/roundcube/roundcubemail/issues