svn commit: r575810 - /commons/proper/email/trunk/RELEASE-NOTES.txt

[bs...@apache.org]

Author: bspeakmon
Date: Fri Sep 14 15:46:27 2007
New Revision: 575810

URL: http://svn.apache.org/viewvc?rev=575810&view=rev
Log:
- draft of release notes for 1.1

Modified:
    commons/proper/email/trunk/RELEASE-NOTES.txt

Modified: commons/proper/email/trunk/RELEASE-NOTES.txt
URL: http://svn.apache.org/viewvc/commons/proper/email/trunk/RELEASE-NOTES.txt?rev=575810&r1=575809&r2=575810&view=diff
==============================================================================
--- commons/proper/email/trunk/RELEASE-NOTES.txt (original)
+++ commons/proper/email/trunk/RELEASE-NOTES.txt Fri Sep 14 15:46:27 2007
@@ -1,37 +1,103 @@
 $Id: RELEASE-NOTES.txt 216015 2005-07-12 20:41:48Z rdonkin $
 
                          Commons Email Package
-                              Version 1.0
+                              Version 1.1
                              Release Notes
 
 INTRODUCTION:
+-------------
 
-Commons-Email aims to provide a API for sending email. It builds on the JavaMail 
+Commons Email aims to provide a API for sending email. It builds on the JavaMail
 API with the aim of presenting a simplified API which is easy for developers who
 are not mail experts to use. It is a compact component with a small number of
 classes.
 
-This is the first release of Commons Email. However, the codebase is mature and
-stable and so this is no reason not to recommend it for production.
+The Commons Email website is the source for the most recent information,
+downloads, reports, and bug status:
 
+http://commons.apache.org/email/
+
+This is a maintenance release which fixes several bugs present in the 1.0
+release and adds a number of small enhancements requested by
+users. All current users are encouraged to upgrade.
+
+CHANGES FROM 1.0:
+-----------------
+
+== Compatibility ==
+
+* Java 1.4 or later is now required. Earlier versions are no longer
+  supported by Sun.
+
+* JavaMail 1.4 or later and JavaBeans Activation Framework 1.1 or later are now
+  required.
+
+* The protected field org.apache.commons.mail.HtmlEmail.inlineImages
+  has been changed from a List to a Map as part of EMAIL-50. Since the
+  field is not intended for direct client use, the great majority of
+  existing clients should not be affected.
+
+== Notable bugfixes ==
+
+* EMAIL-50: HtmlEmails were not being constructed correctly; several
+  email clients were not displaying attachments or embedded images
+  properly. As part of the same problem, duplicate embeds were not
+  being handled correctly.
+
+* EMAIL-1: Email.setContent() was not taking a specified charset into
+  account. Additional setContent() overloadings were also added to
+  address common use cases.
+
+== Notable enhancements ==
+
+* EMAIL-35: HtmlEmail now supports the embedding of any DataSource
+  implementation. Specific methods were added for File and URL
+  objects, removing the need for clumsy circumlocution.
+
+* Character set handling and encoding has been overhauled to use the
+  JDK 1.4 character set support. All charsets supported by the Java VM
+  are now recognized and handled appropriately in Email.setCharset()
+  and Email.setContent() calls.
+
+* HtmlEmail performance has been slightly improved.
+
+* The MIME structure of MultiPartEmail and HtmlEmail has been improved.
 
 REQUIREMENTS:
 
 J2SE environments
 -----------------
 
-Commons-Email requires at least javamail version 1.2 and should run
-with all versions above. Get it http://java.sun.com/products/javamail/
+Commons Email requires JavaMail 1.4 or later. The proprietary Sun implementation
+is available at:
+
+http://java.sun.com/products/javamail/  
+
+However, the Apache Geronimo project (http://geronimo.apache.org)
+provides a J2EE-certified implementation of the JavaMail 1.4
+specification licensed under the Apache Software License.  
+
+Commons Email also requires the JavaBeans Activation Framework. The
+proprietary Sun implementation is available at:
 
-Commons-Email also requires the Java activation framework. Get it from
 http://java.sun.com/products/javabeans/glasgow/jaf.html
 
-Commons-Email has been tested with JDK 1.3.1_16, JDK 1.4.2_09 and JDK 1.5.0_04.
+Apache Geronimo likewise provides an implementation under the Apache
+Software License.
+
+Commons Email has been tested with JDK 1.4.2_15 and JDK 1.5.0_12.
 
 J2EE environments
 -----------------
 
-Commons-Email should be compatible with J2EE 1.3 and 1.4 compliant
-environments and run without additional requirements.
+Commons Email is compatible with all certified Java Enterprise Edition
+5 implementations; no further dependencies are required. 
+
+Java 2 Enterprise Edition 1.4 users must ensure that the versions of
+JavaMail and JAF indicated above are available to their applications;
+the J2EE 1.4 specification only requires earlier versions.
+
+Earlier versions of J2EE are not supported.
+