Insert notes about PHP 4.3.x into some documentation.
[squirrelmail.git] / ReleaseNotes
1 /*****************************************************************
2  * Release Notes: SquirrelMail 1.4.0 Release Candidate 2a        *
3  * 24 January 2002                                               *
4  *****************************************************************/
5
6 In this edition of SquirrelMail Release Notes:
7    * All about this Release!!!
8    * A note on PHP 4.3.x
9    * Major updates
10    * A note on plugins
11    * Reporting my favorite SquirrelMail 1.4 bug
12
13 All about this Release!!!
14 =========================
15
16 This is the second and hopefully last Release Candidate (RC) for the
17 1.4.x stable series. Please note that this release is not yet labeled
18 STABLE officially.
19
20 It is labeled RC 2a because RC 2 was released but pulled back soon
21 after because a serious bug was found that needed to be fixed. Thanks
22 to Jason Munro for discovering this bug.
23
24 However, we've been running this on a number of systems and a variety
25 of configs and we think it's worthy of the "stable"-title. Before we
26 can call it stable we want to test it on as many systems as possible
27 to iron out the last issues. 
28
29 In response to RC1, quite some issues were reported AND fixed! We now
30 hope that SquirrelMail is really ready to be called STABLE. We need you
31 to verify that this is true!
32
33 So download it! Install it, and try to break it! We are hungry for any
34 bug report you send. Even the smallest issue deserves to be fixed.
35
36 A note on PHP 4.3.x
37 ===================
38
39 While the developers realize that PHP 4.3.x is the "latest and greatest"
40 version of PHP to be available, SquirrelMail has not been extensively
41 tested with it.  There may be potential session issues with PHP 4.3.x,
42 and PHP by default has a session warning which will need to be disabled
43 if you wish to use it with SquirrelMail.
44
45 Put simply: The SquirrelMail team does not recommend the use of
46 PHP 4.3.x with SquirrelMail at this time.
47
48 SquirrelMail will put a large ugly warning about the use of PHP 4.3.x on
49 the login screen unless you add "$shootMyFootOff = true;" to 
50 config/config_local.php, or downgrade PHP.
51
52 Major updates
53 ==============
54
55 The 1.4.0 series (as a result of 1.3 devel series) brings:
56
57 * A complete rewrite of the way we send mail (Deliver-class),
58   and of the way we parse mail (MIME-bodystructure parsing).
59   This makes SquirrelMail more reliable and more efficient
60   at the same time!
61 * Support for IMAP UID which makes SquirrelMail more reliable.
62 * Optimizations to code and the number of IMAP calls.
63 * Support for a wider range of authentication mechanisms.
64 * Lots of bugfixes and a couple of UI-tweaks.
65
66
67 A note on plugins
68 =================
69
70 There have been major plugin architecture improvements. Lots of plugins
71 have not yet been adapted to this. Plugins which are distributed with
72 this release (eg. in the same .tar.gz file) should work. Plugins not
73 distributed with this plugin most probably WILL NOT WORK.
74
75 So if you have ANY problem at all, first try turning off all plugins.
76
77
78 A note on your configuration
79 ============================
80
81 For a whole bunch of reasons, it is MANDATORY that you run conf.pl
82 (and then save your configuration) from the config/ directory before
83 using this release.
84
85 If you have problems with UID support, please do these 2 things:
86
87 1) For our comfort and the prosperity of SquirrelMail, send a bug
88    report with this information:
89      * IMAP server type + version
90      * Whether you use server-side sorting
91      * Whether you use thread sorting
92      * The value of "sort" (as in conf.pl)
93    Bugs can be submitted at: http://www.squirrelmail.org/bugs
94
95 2) For your own pleasure and comfort:
96    Turn off UID support in conf.pl, so you can continue to use 1.4.0
97    while the developers look at your report.
98
99
100 Reporting my favorite SquirrelMail 1.4 bug
101 ==========================================
102
103 This RC is meant to catch the last bugs. So we need you to submit
104 any bug you come across! Also, please mention that the bug is in
105 this 1.4.0 RC2 release.
106
107    http://www.squirrelmail.org/bugs
108
109 Thanks for your cooperation with this. That helps us to make
110 sure nothing slips through the cracks. Also, it would help if
111 people would check existing tracker items for a bug before reporting
112 it again. This would help to eliminate duplicate reports, and
113 increase the time we can spend CODING by DECREASING the time we
114 spend sorting through bug reports. And remember, check not only OPEN
115 bug reports, but also closed ones as a bug that you report MAY have
116 been fixed in CVS already.
117
118 If you want to join us in coding SquirrelMail, or have other
119 things to share with the developers, join the development mailinglist:
120
121    squirrelmail-devel@lists.sourceforge.net
122
123
124                   Happy SquirrelMailing!
125                     - The SquirrelMail Project Team