tmail 1.2.0 → 1.2.1

data/CHANGES

@@ -1,3 +1,14 @@
+= TMail 1.2.1 / 2008-01-11
+
+* More documentation (Mikel)
+* Added 15 test cases from the Rails ActionMailer to TMail
+* Changed mailscanner to tmailscanner (mailscanner is copyrighted)
+* Closed Bug -  Handled quote boundary being gready on content-type header (M. Mondragon)
+* Closed #16025 - Fixed scanner.rb so it passes same tests as scanner.c
+* Closed #16283 - Handled incorrect decoding of attachments (M. Aoki - garyo)
+* Closed #16899 - HeaderField.new_from_port and added test cases to cover this code (Maarten O.)
+* Closed #16900 - UNIXMbox.fromaddr missing port param and does not return Envelope Sender (Maarten O.)
+
 = TMail 1.2.0 / 2007-11-29
 
 * Extensive documentation work. (mikel)

data/NOTES

@@ -1,4 +1,4 @@
-[ANN] TMail 1.2.0
+[ANN] TMail 1.2.1 - 11 Jan 2008
 
 TMail is The Mail Handling Library for Ruby!
 
@@ -20,49 +20,59 @@ http://tmail.rubyforge.org/
 
 Release Summary:
 ------------------
-New release handles two tickets in the TMail
+New release handles five tickets in the TMail
 tracker as well as a lot more documentation and
-removes an unnecessary c-library.
+renames a library to handle copyright concerns.
+
+Additionally added 25 more test cases to the library
+to handle the above tickets.
+
+This should be a drop in replacement for existing
+TMail installations.
 
 
 Release Update Details:
 -------------------------
 
-Closed 15445 - TMail::Mail#create_forward now returns
-a new Mail object that has the original mail as an
-encoded 7 bit multipart attachment.  Also moved
-create_forward and create_reply from tmail/net
-into tmail/interface as it makes more sense to have
-it there.
-
-Closed 15643 - TMail::Mail#reply_addresses was
-returning an empty array if reply_to was set to nil
-(ie, the header field existed but was empty) instead
-of returning the from address or default.
-
-Removed base64.c after doing profiling on several
-platforms and finding out that the Ruby inbuilt
-version is just as fast (varies per platform but
-all in all about the same speed.)
-
-Renamed the Scanner_C extension to MailScanner.
-
-New release adds extensive new documentation to
-mainly the TMail::Mail class, approximately 500
-lines of examples have been included in the RDoc.
-
-Added a default value to TMail::Mail#sender method
-to allow arbitrary defaults to be passed into the
-method in alignment with all the other mail interface
-methods.
-
-Made base64_decode and base64_encode into ! versions
-as they are destructive on the mail body (encodes the
-body to base64 or decodes it), made aliases for
-base64_decode and base64_encode to point back to the
-bang versions.  Doing this with a view to change
-base64_encode to a non destructive version
-(returns the encoded body) in future versions.
+Closed #16899 - HeaderField.new_from_port and added test
+cases to cover this code. Also changed behaviour of
+HeaderField.new_from_port to return nil if it does not
+find a matching header in the port provided. Extended
+UNIXMbox.fromaddr to also search for EnvelopeSender and
+also made it a public method, not private - Thanks to
+Maarten O. for alerting these bugs
+
+Closed #16900 - UNIXMbox.fromaddr missing port param and
+does not return Envelope Sender. This report was
+initially to correct typo on "Regep" to "Regexp". Also
+added test cases to cover this class method. Also added
+ability to scan for the EnvelopeSender explictly as it
+would not come up on searching for "From" due to Regexp
+confilct with From: (with the colon). Thanks to Maarten
+O. for reporting this.
+
+Closed 16025 - TMail scanner.rb would not parse ATOM
+chars correctly making it fail tests where the C version
+passed them. Fixed this by updating the Scanner.rb
+version to be in step with the C version (there was an
+extra @ symbol in the ATOM CHARS definition that was not
+in the C version.) (mikel)
+
+Closed 16283 - TMail would not decode correctly due to
+bug in text-utils - put in previous patch from old tmail
+trunk version. Thanks to garyo for spotting this.
+
+Closed Bug - Handled quote boundary being gready on
+content-type header fields (M. Mondragon)
+
+Changed the name of mailscanner to tmailscanner to handle
+a copyright issue. MailScanner is a copyrighted name.
+
+Added about 15 test cases from the Rails community. Added
+failing test case for an unquoted @ char in the From
+header field. Need to check fully if this is needed or
+not, but it is there anyway - to be resolved. I have
+emailed 822 mailing list to check this out.
 
 See the changelog for previous changes.
 

data/README

@@ -28,6 +28,8 @@ I really welcome any examples of Emails that "didn't work" with TMail so I can u
 
 TMail is very easy to use.  You simply require the library and then pass a raw email text message into the TMail::Mail.parse method.  This returns a TMail::Mail object which you can now query and run methods against to modify, inspect or add to the Email.
 
+You can find almost all of the methods that you will use to talk to and update a TMail instance in the TMail::Mail class.  I am constantly updating this code, with comments, added a fair bit and have a lot more to go!.
+
 === Short Version:
 
   irb(main):001:0> require 'tmail'
@@ -123,8 +125,7 @@ You can just call to_s on any email to have it serialized out as a single string
 
 == REQUIREMENTS:
 
-* Ruby 1.6 or later
-* C compiler if you want the Ruby extensions for Scanner and Base64
+* C compiler if you want the Ruby extension for Scanner
 * Ruby 1.8 or later
 
 == INSTALLATION:

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+# Run the unit tests
+Rake::TestTask.new { |t|
+  t.libs << "test"
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+  t.warning = false
+}

data/ext/Makefile

@@ -2,19 +2,19 @@
 # ext/tmail/Makefile
 #
 
-.PHONY: mailscanner clean distclean
+.PHONY: tmailscanner clean distclean
 
-all: mailscanner
+all: tmailscanner
 
-mailscanner: mailscanner/tmail/Makefile
-	cd mailscanner/tmail; $(MAKE)
+tmailscanner: tmailscanner/tmail/Makefile
+	cd tmailscanner/tmail; $(MAKE)
 
-mailscanner/tmail/Makefile: mailscanner/tmail/extconf.rb
-	cd mailscanner/tmail; ruby extconf.rb
+tmailscanner/tmail/Makefile: tmailscanner/tmail/extconf.rb
+	cd tmailscanner/tmail; ruby extconf.rb
 
 clean:
-	cd mailscanner/tmail; $(MAKE) clean
+	cd tmailscanner/tmail; $(MAKE) clean
 
 distclean:
-	cd mailscanner/tmail; $(MAKE) distclean
+	cd tmailscanner/tmail; $(MAKE) distclean
 

data/ext/{mailscanner → tmailscanner}/tmail/MANIFEST

@@ -1,4 +1,4 @@
 MANIFEST
-mailscanner.c
+tmailscanner.c
 extconf.rb
 depend

data/ext/tmailscanner/tmail/depend

@@ -0,0 +1 @@
+tmailscanner.o: tmailscanner.c $(hdrdir)/ruby.h $(topdir)/config.h $(hdrdir)/defines.h Makefile

data/ext/{mailscanner → tmailscanner}/tmail/extconf.rb

@@ -1,7 +1,7 @@
 require 'mkmf'
 require 'rbconfig'
 
-extension_name = 'mailscanner'
+extension_name = 'tmailscanner'
 
 arch = Config::CONFIG['sitearch']
 

data/ext/{mailscanner/tmail/mailscanner.c → tmailscanner/tmail/tmailscanner.c}

@@ -1,6 +1,6 @@
 /*
 
-    mailscanner.c
+    tmailscanner.c
 
     Copyright (c) 1998-2007 Minero Aoki
 
@@ -21,7 +21,7 @@
 
 #define TMAIL_VERSION "0.11.0"
 
-static VALUE MailScanner;
+static VALUE TMailScanner;
 static VALUE ScanError;
 
 struct scanner
@@ -95,7 +95,7 @@ mails_s_new(klass, str, ident, cmt)
         sc->comments = cmt;
     }
 
-    return Data_Wrap_Struct(MailScanner, 0, mails_free, sc);
+    return Data_Wrap_Struct(TMailScanner, 0, mails_free, sc);
 }
 
 /*
@@ -538,7 +538,7 @@ cstr2symbol(str)
 }
 
 void
-Init_mailscanner()
+Init_tmailscanner()
 {
     VALUE TMail;
     VALUE tmp;
@@ -549,16 +549,16 @@ Init_mailscanner()
     else {
         TMail = rb_define_module("TMail");
     }
-    MailScanner = rb_define_class_under(TMail, "MailScanner", rb_cObject);
+    TMailScanner = rb_define_class_under(TMail, "TMailScanner", rb_cObject);
 
     tmp = rb_str_new2(TMAIL_VERSION);
     rb_obj_freeze(tmp);
-    rb_define_const(MailScanner, "Version", tmp);
+    rb_define_const(TMailScanner, "Version", tmp);
 
-    rb_define_singleton_method(MailScanner, "new", mails_s_new, 3);
-    rb_define_method(MailScanner, "scan", mails_scan, 0);
-    rb_define_method(MailScanner, "debug", mails_debug_get, 0);
-    rb_define_method(MailScanner, "debug=", mails_debug_set, 1);
+    rb_define_singleton_method(TMailScanner, "new", mails_s_new, 3);
+    rb_define_method(TMailScanner, "scan", mails_scan, 0);
+    rb_define_method(TMailScanner, "debug", mails_debug_get, 0);
+    rb_define_method(TMailScanner, "debug=", mails_debug_set, 1);
 
     if (rb_const_defined(TMail, rb_intern("SyntaxError"))) {
         ScanError = rb_const_get(rb_cObject, rb_intern("SyntaxError"));

data/lib/tmail/address.rb

@@ -54,8 +54,16 @@ module TMail
           raise SyntaxError, 'empty word in domain' if s.empty?
         end
       end
+      
+      # This is to catch an unquoted "@" symbol in the local part of the
+      # address.  Handles addresses like <"@"@me.com> and makes sure they
+      # stay like <"@"@me.com> (previously were becomming <@@me.com>)
+      if local.to_s == '@' || local.to_s =~ /\A[^"].*?@.*?[^"]\Z/ 
+        @local = "\"#{local.to_s}\""
+      else
+        @local = local
+      end
 
-      @local = local
       @domain = domain
       @name   = nil
       @routes = []

data/lib/tmail/encode.rb

@@ -195,6 +195,7 @@ module TMail
       @f = StrategyInterface.create_dest(dest)
       @opt = OPTIONS[$KCODE]
       @eol = eol
+      @folded = false
       @preserve_quotes = true
       reset
     end

data/lib/tmail/header.rb

@@ -54,8 +54,40 @@ module TMail
         klass.newobj body, conf
       end
 
+      # Returns a HeaderField object matching the header you specify in the "name" param.
+      # Requires an initialized TMail::Port to be passed in.
+      #
+      # The method searches the header of the Port you pass into it to find a match on
+      # the header line you pass.  Once a match is found, it will unwrap the matching line
+      # as needed to return an initialized HeaderField object.
+      #
+      # If you want to get the Envelope sender of the email object, pass in "EnvelopeSender",
+      # if you want the From address of the email itself, pass in 'From'.
+      #
+      # This is because a mailbox doesn't have the : after the From that designates the
+      # beginning of the envelope sender (which can be different to the from address of 
+      # the emial)
+      #
+      # Other fields can be passed as normal, "Reply-To", "Received" etc.
+      #
+      # Note: Change of behaviour in 1.2.1 => returns nil if it does not find the specified
+      # header field, otherwise returns an instantiated object of the correct header class
+      # 
+      # For example:
+      #   port = TMail::FilePort.new("/test/fixtures/raw_email_simple")
+      #   h = TMail::HeaderField.new_from_port(port, "From")
+      #   h.addrs.to_s #=> "Mikel Lindsaar <mikel@nowhere.com>"
+      #   h = TMail::HeaderField.new_from_port(port, "EvelopeSender")
+      #   h.addrs.to_s #=> "mike@anotherplace.com.au"
+      #   h = TMail::HeaderField.new_from_port(port, "SomeWeirdHeaderField")
+      #   h #=> nil
       def new_from_port( port, name, conf = DEFAULT_CONFIG )
-        re = Regep.new('\A(' + Regexp.quote(name) + '):', 'i')
+        if name == "EnvelopeSender"
+          name = "From"
+          re = Regexp.new('\A(From) ', 'i')
+        else
+          re = Regexp.new('\A(' + Regexp.quote(name) + '):', 'i')
+        end
         str = nil
         port.ropen {|f|
             f.each do |line|
@@ -66,7 +98,7 @@ module TMail
               end
             end
         }
-        new(name, str, Config.to_config(conf))
+        new(name, str, Config.to_config(conf)) if str
       end
 
       def internal_new( name, conf )

data/lib/tmail/mailbox.rb

@@ -213,13 +213,13 @@ module TMail
               fromaddr(), TextUtils.time2str(File.mtime(port.filename))
     end
 
-    def UNIXMbox.fromaddr
+    def UNIXMbox.fromaddr(port)
       h = HeaderField.new_from_port(port, 'Return-Path') ||
-          HeaderField.new_from_port(port, 'From') or return 'nobody'
+      HeaderField.new_from_port(port, 'From') ||
+      HeaderField.new_from_port(port, 'EnvelopeSender') or return 'nobody'
       a = h.addrs[0] or return 'nobody'
       a.spec
     end
-    private_class_method :fromaddr
 
     def close
       return if @closed

data/lib/tmail/quoting.rb

@@ -116,27 +116,3 @@ module TMail
     end
   end
 end
-
-if __FILE__ == $0
-  require 'test/unit'
-
-  class TC_Unquoter < Test::Unit::TestCase
-    def test_unquote_quoted_printable
-      a ="=?ISO-8859-1?Q?[166417]_Bekr=E6ftelse_fra_Rejsefeber?="
-      b = TMail::Unquoter.unquote_and_convert_to(a, 'utf-8')
-      assert_equal "[166417] Bekr\303\246ftelse fra Rejsefeber", b
-    end
-
-    def test_unquote_base64
-      a ="=?ISO-8859-1?B?WzE2NjQxN10gQmVrcuZmdGVsc2UgZnJhIFJlanNlZmViZXI=?="
-      b = TMail::Unquoter.unquote_and_convert_to(a, 'utf-8')
-      assert_equal "[166417] Bekr\303\246ftelse fra Rejsefeber", b
-    end
-
-    def test_unquote_without_charset
-      a ="[166417]_Bekr=E6ftelse_fra_Rejsefeber"
-      b = TMail::Unquoter.unquote_and_convert_to(a, 'utf-8')
-      assert_equal "[166417]_Bekr=E6ftelse_fra_Rejsefeber", b
-    end
-  end
-end

data/lib/tmail/scanner.rb

@@ -34,15 +34,15 @@ require 'tmail/utils'
 require 'tmail/config'
 
 module TMail
-  # NOTE: It woiuld be nice if these two libs could boith be called "mailscanner", and
+  # NOTE: It woiuld be nice if these two libs could boith be called "tmailscanner", and
   # the native extension would have precedence. However RubyGems boffs that up b/c
   # it does not gaurantee load_path order.
   begin
     raise LoadError, 'Turned off native extentions by user choice' if ENV['NORUBYEXT']
-    require('tmail/mailscanner') # c extension
-    Scanner = MailScanner
+    require('tmail/tmailscanner') # c extension
+    Scanner = TMailScanner
   rescue LoadError
     require 'tmail/scanner_r'
-    Scanner = MailScanner
+    Scanner = TMailScanner
   end
 end

data/lib/tmail/scanner_r.rb

@@ -31,7 +31,7 @@ require 'tmail/config'
 
 module TMail
 
-  class MailScanner
+  class TMailScanner
 
     Version = '0.11.0'
     Version.freeze

data/lib/tmail/utils.rb

@@ -248,8 +248,7 @@ module TMail
     def decode_RFC2231( str )
       m = RFC2231_ENCODED.match(str) or return str
       begin
-        NKF.nkf(NKF_FLAGS[$KCODE],
-        m.post_match.gsub(/%[\da-f]{2}/in) {|s| s[1,2].hex.chr })
+        to_kcode(m.post_match.gsub(/%[\da-f]{2}/in) {|s| s[1,2].hex.chr })
       rescue
         m.post_match.gsub(/%[\da-f]{2}/in, "")
       end
@@ -263,7 +262,7 @@ module TMail
         preamble = $1
         remainder = $2
         if remainder =~ /;/
-          remainder =~ /^(.*)(;.*)$/m
+          remainder =~ /^(.*?)(;.*)$/m
           boundary_text = $1
           post = $2.chomp
         else

data/lib/tmail/version.rb

@@ -31,7 +31,7 @@ module TMail #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 2
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/log/ChangeLog.txt

@@ -1,7 +1,29 @@
+== Thu Jan 10 15:09:02 GMT 2008 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Closed #16899 - HeaderField.new_from_port and added test cases to cover this code. Also changed behaviour of HeaderField.new_from_port to return nil if it does not find a matching header in the port provided.  Extended UNIXMbox.fromaddr to also search for EnvelopeSender and also made it a public method, not private - Thanks to Maarten O. for alerting these bugs
+
+* Closed #16900 - UNIXMbox.fromaddr missing port param and does not return Envelope Sender.  This report was initially  to correct typo on "Regep" to "Regexp".  Also added test cases to cover this class method.  Also added ability to scan for the EnvelopeSender explictly as it would not come up on searching for "From" due to Regexp confilct with From: (with the colon).  Thanks to Maarten O. for reporting this.
+
+== Thu Dec 25 23:10:16 GMT 2007 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Closed Bug -  Handled quote boundary being gready on content-type header fields (M. Mondragon)
+
+== Thu Dec 25 20:10:46 GMT 2007 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Change the name of mailscanner to tmailscanner to handle a copyright issue.  MailScanner is a copyrighted name.
+
+== Thu Dec 02 11:11:36 GMT 2008 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Added about 15 test cases from the Rails community.  Added failing test case for an unquoted @ char in the From header field.  Need to check fully if this is needed or not, but it is there anyway - to be resolved.  I have emailed 822 mailing list to check this out.
+
 == Fri Nov 30 08:04:09 GMT 2007 Mikel Lindsaar <raasdnil@gmail.com>
 
 * Closed 16025 - TMail scanner.rb would not parse ATOM chars correctly making it fail tests where the C version passed them.  Fixed this by updating the Scanner.rb version to be in step with the C version (there was an extra @ symbol in the ATOM CHARS definition that was not in the C version.) (mikel)
 
+== Fri Nov 25 05:41:15 GMT 2007 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Closed 16283 - TMail would not decode correctly due to bug in text-utils - put in previous patch from old tmail trunk version. Thanks to garyo for spotting this.
+
 == Mon Nov 19 23:15:29 GMT 2007 Mikel Lindsaar <raasdnil@gmail.com>
 
 * Added about 500 lines of documentation to the interface.rb file.