Skip to content

Commit

Permalink
Updated change log, version bump to 1.2.1 and updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mikel committed Nov 4, 2009
1 parent 2b5d608 commit a303b1f
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 18 deletions.
13 changes: 9 additions & 4 deletions CHANGELOG.rdoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
== Wed Nov 4 23:24:32 UTC 2009 Mikel Lindsaar <raasdnil@gmail.com>

* Created commit 2b5d608: Closes Issue #2 - Empty header field values not parsing <mikel>
* Version bumb to 1.2.1

== Wed Nov 4 12:54:43 UTC 2009 Mikel Lindsaar <raasdnil@gmail.com>

* Renamed Mail::Message.encode! to Mail::Message.ready_to_send!, deprecated :encode!
* Renamed Mail::Message.encode! to Mail::Message.ready_to_send!, deprecated :encode! <mikel>
* Rewrote encoding and decoding methods on all classes. Adds a lot of boiler plate code, but allows us to
be really precise in each field type that needs custom encoding. Now all encoding is done by the field_type
itself. Need to follow through on the body.
* Bump version to 1.2.0 due to changes of :encoded, :decoded behaviour
itself. Need to follow through on the body. <mikel>
* Bump version to 1.2.0 due to changes of :encoded, :decoded behaviour <mikel>

== Tue Nov 3 00:59:45 UTC 2009 Mikel Lindsaar <raasdnil@gmail.com>

* Tested mail against entire Enron set (2.3gb) and the Trec 2005 set (0.5gb), ~ half a million emails without crashing
* Tested mail against entire Enron set (2.3gb) and the Trec 2005 set (0.5gb), ~ half a million emails without crashing <jlindley>
* Some headers only can appear once, enforce during header parse assignment. <jlindley>
* Convert empty bodies into empty arrays instead of nil. <jlindley>
* Handle blank content dispositions. <jlindley>
Expand Down
27 changes: 14 additions & 13 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ and you can manually create any other type of MIME email.

Next TODO:

* Add multilingual MIME support for mixed ASCII and multibyte headers
* Improve MIME support for character sets in headers, currently works, mostly, needs
refinement.
* Add IMAP wrapper

== Testing Policy
Expand All @@ -64,13 +65,10 @@ It also means you can be sure Mail will behave correctly.

== API Policy

Right now Mail is still under development for a 1.0.0 release.
No API removals within a single point release. All removals to be depreciated with
warnings for at least one MINOR point release before removal.

The API will change between now and 1.0.0. How much? Not sure. Basically though
once 1.0.0 is released, no API removals within a single point release. All removals
to be depreciated with warnings for at least one point release before removal.

Also, all private or protected methods to be declared as such.
Also, all private or protected methods to be declared as such - though this is still I/P.

== Installation

Expand All @@ -89,7 +87,7 @@ may or may not be a problem for you.

If you want to install mail manually, you can download the gem from github and do:

# gem install mail-1.0.0.gem
# gem install mail-1.2.1.gem

== Encodings

Expand All @@ -102,14 +100,18 @@ I have tried to simplify it some:
return the object as a complete string ready to send in the mail system, that is,
it will include the header field and value and CRLF at the end and wrapped as
needed.

2. All objects that can render into an email, have a :decoded method. Decoded will
return the object's "value" only as a string. This means it will not include
the header fields (like 'To:' or 'Subject:').

3. By default, calling :to_s on an object will call it's encoded method, that is, make
it ready to send in an email.

4. Structured fields that have parameter values that can be encoded (e.g. Content-Type) will
provide decoded parameter values when you call the parameter names as methods against
the object.

5. Structured fields that have parameter values that can be encoded (e.g. Content-Type) will
provide encoded parameter values when you call the parameter names through the
object.parameters['<parameter_name>'] method call.
Expand Down Expand Up @@ -440,11 +442,10 @@ Of course... Mail will round trip an attachment as well

== Excerpts from TREC Spam Corpus 2005

The spec fixture files in spec/fixtures/emails/from_trec_2005
are from the 2005 TREC Public Spam Corpus. They remain copyrighted
under the terms of that project and license agreement. They are used
in this project to verify and describe the development of this
email parser implementation.
The spec fixture files in spec/fixtures/emails/from_trec_2005 are from the
2005 TREC Public Spam Corpus. They remain copyrighted under the terms of
that project and license agreement. They are used in this project to verify
and describe the development of this email parser implementation.

http://plg.uwaterloo.ca/~gvcormac/treccorpus/

Expand Down
2 changes: 1 addition & 1 deletion lib/mail/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Mail
module VERSION
MAJOR = 1
MINOR = 2
TINY = 0
TINY = 1

STRING = [MAJOR, MINOR, TINY].join('.')
end
Expand Down

0 comments on commit a303b1f

Please sign in to comment.