Converting 1.0 trunk to a branch.
[squirrelmail.git] / README
1 SquirrelMail
2 http://www.squirrelmail.org
3
4 NOTE: Converting 1.0 trunk to a 1.0 branch.
5
6 Introduction:
7 -------------
8 SquirrelMail is a standards-based webmail package written in PHP4. It
9 includes built-in pure PHP support for the IMAP and SMTP protocols, and all
10 pages render in pure HTML 4.0 (with no Javascript) for maximum compatibility
11 across browsers. It has very few requirements and is very easy to configure
12 and install. SquirrelMail has a all the functionality you would want from an
13 email client, including strong MIME support, address books, and folder
14 manipulation.  
15
16 Why did you guys create SquirrelMail?  The need arose in our organization
17 for the access of email and address books from anywhere in the world.
18 Obviously a web interface is ideal for this, given that the user has access
19 to the Internet.  After reviewing several open source projects, we realized
20 that we were going to need to do some fairly major customizations to get
21 things to be a nice fit for our needs.  So the decision was made to create
22 our own for some of these reasons, and for fun (we really like PHP4).  We
23 decided to open source the project to contribute to the community that has
24 contributed so much to us.  Since then, it has grown much bigger than we
25 ever imagined, and we have an awesome development team who are actively
26 working on the project.
27
28 We would love to hear from you!  The nature of open source projects make it
29 hard to know who all is using your product.  It is always nice when we get
30 emails from people just telling us that they're using SquirrelMail.  If you
31 have a few minutes, please send us an email to let us know!  You can send it
32 to our mailing list:  squirrelmail-list@sourceforge.net
33
34 You can also go to the page below and fill out a small form to get listed
35 with the list of people already using SquirrelMail (free advertising).
36
37    http://www.squirrelmail.org/index.php3?page=16
38
39 Contact:
40 --------
41 It is pretty easy to get in contact with the developers if you need help or
42 if you find bugs that need to be reported.  The best way to contact us would
43 be through our mailing list which is actively monitored.  Just send an email
44 to:
45    
46    squirrelmail-list@sourceforge.net
47
48 If you wish to actually subscribe to our mailing list, please visit our web
49 page for instructions (http://www.squirrelmail.org) and go to the section
50 titled "Mailing List".
51
52 Installation:
53 -------------
54 For detailed instructions on how to install SquirrelMail on your server,
55 please refer to the INSTALL document in the same directory as this document.
56
57 Licensing: 
58 ----------
59 This product is distributed under the GPL.  Please read through the file
60 COPYING for more information about our license.