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