add fixme
[squirrelmail.git] / README
1 SquirrelMail
4 Introduction:
5 -------------
6 SquirrelMail is a standards-based webmail package written in PHP. It
7 includes built-in pure PHP support for the IMAP and SMTP protocols, and all
8 pages render in pure HTML 4.0 (with no Javascript) for maximum compatibility
9 across browsers. It has very few requirements and is very easy to configure
10 and install. SquirrelMail has all the functionality you would want from an
11 email client, including strong MIME support, address books, and folder
12 manipulation.
14 Why did you guys create SquirrelMail? The need arose in our organization
15 for the access of email and address books from anywhere in the world.
16 Obviously a web interface is ideal for this, given that the user has access
17 to the Internet. After reviewing several open source projects, we realized
18 that we were going to need to do some fairly major customizations to get
19 things to be a nice fit for our needs. So the decision was made to create
20 our own for some of these reasons, and for fun (we really like PHP). We
21 decided to open source the project to contribute to the community that has
22 contributed so much to us. Since then, it has grown much bigger than we
23 ever imagined, and we have an awesome development team who are actively
24 working on the project.
26 We would love to hear from you! The nature of open source projects make it
27 hard to know who all is using your product. It is always nice when we get
28 emails from people just telling us that they're using SquirrelMail. If you
29 have a few minutes, please send us an email to let us know! You can send it
30 to our mailing list:
32 Contact:
33 --------
34 It is pretty easy to get in contact with the developers if you need help or
35 if you find bugs that need to be reported. The best way to contact us would
36 be through our mailing list which is actively monitored.
40 NOTE: you need to be subscribed to this mailinglist to be able to post to it!
41 Please visit our web page ( and go to the section
42 titled "Mailing Lists".
44 Installation:
45 -------------
46 For detailed instructions on how to install SquirrelMail on your server,
47 please refer to the INSTALL document in the same directory as this document.
49 Licensing:
50 ----------
51 This program is free software; you can redistribute it and/or
52 modify it under the terms of the GNU General Public License
53 as published by the Free Software Foundation; either version 2
54 of the License, or (at your option) any later version.
56 This program is distributed in the hope that it will be useful,
57 but WITHOUT ANY WARRANTY; without even the implied warranty of
59 GNU General Public License for more details.
61 You should have received a copy of the GNU General Public License
62 along with this program (in the file COPYING); if not, write to the
63 Free Software Foundation, Inc.,
64 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA