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