tmail 1.1.1 → 1.2.0

data/CHANGES

@@ -0,0 +1,5 @@
+= TMail 1.2.0 / 2007-11-29
+
+* Extensive documentation work. (mikel)
+* Renamed scanner_c.c to mailscanner.c.
+* Removed base64 c extension. It's speed benefit was negligable (only 0.2 sec over 10000 sizable encode/decode runs).

data/NOTES

@@ -0,0 +1,84 @@
+[ANN] TMail 1.2.0
+
+TMail is The Mail Handling Library for Ruby!
+
+TMail is the Ruby Mail handler used in the 
+Ruby on Rails and Nitro web frame works as
+well as many others (now including, the Ruby
+Talk mail gateway!).
+
+TMail is now a gem. You can install it on any
+platform via:
+
+# gem install tmail
+
+Alternatively you can download the source code
+or view extra documentation at the website:
+
+http://tmail.rubyforge.org/
+
+
+Release Summary:
+------------------
+New release handles two tickets in the TMail
+tracker as well as a lot more documentation and
+removes an unnecessary c-library.
+
+
+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.
+
+See the changelog for previous changes.
+
+
+Bug Reports / Fixes:
+----------------------
+
+As always, we really welcome any bug reports or code
+for patches you have created.  Please submit anything
+you find through our RubyForge tracker project which
+you can get to from our website:
+
+http://tmail.rubyforge.org/
+
+
+We hope you enjoy this release!
+
+
+The TMail Team.

data/README

@@ -127,10 +127,14 @@ You can just call to_s on any email to have it serialized out as a single string
 * C compiler if you want the Ruby extensions for Scanner and Base64
 * Ruby 1.8 or later
 
-== Installation
+== INSTALLATION:
 
 * sudo gem install tmail
 
+Or manually,
+
+* sudo script/setup
+
 == LICENSE:
 
 (The MIT License)
@@ -155,3 +159,4 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/ext/Makefile

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

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

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

data/ext/mailscanner/tmail/depend

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

data/ext/mailscanner/tmail/extconf.rb

@@ -0,0 +1,24 @@
+require 'mkmf'
+require 'rbconfig'
+
+extension_name = 'mailscanner'
+
+arch = Config::CONFIG['sitearch']
+
+windows = (/djgpp|(cyg|ms|bcc)win|mingw/ =~ arch)
+
+if (ENV['NORUBYEXT'] == 'true')
+  File.open('Makefile', 'w') do |f|
+    f << "all:\n"
+    f << "install:\n"
+  end
+else
+  #dir_config(extension_name)
+  if windows && ENV['make'].nil?
+    $LIBS += " msvcprt.lib"
+  else
+    $CFLAGS += " -D_FILE_OFFSET_BITS=64"  #???
+  end
+  create_makefile(extension_name)
+end
+

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

@@ -1,6 +1,6 @@
 /*
 
-    scanner_c.c
+    mailscanner.c
 
     Copyright (c) 1998-2007 Minero Aoki
 
@@ -19,7 +19,7 @@
 #include "re.h"
 
 
-#define TMAIL_VERSION "0.10.8"
+#define TMAIL_VERSION "0.11.0"
 
 static VALUE MailScanner;
 static VALUE ScanError;
@@ -58,7 +58,7 @@ mails_free(sc)
 
 /*
  * Document-method: mails_s_new
- * 
+ *
  * Creates a new mail
  *
  */
@@ -100,7 +100,7 @@ mails_s_new(klass, str, ident, cmt)
 
 /*
  * Document-method: mails_debug_get
- * 
+ *
  * TODO: Documentation needed
  *
  */
@@ -119,7 +119,7 @@ mails_debug_get(self)
 
 /*
  * Document-method: mails_debug_set
- * 
+ *
  * TODO: Documentation needed
  *
  */
@@ -538,7 +538,7 @@ cstr2symbol(str)
 }
 
 void
-Init_scanner_c()
+Init_mailscanner()
 {
     VALUE TMail;
     VALUE tmp;
@@ -549,7 +549,7 @@ Init_scanner_c()
     else {
         TMail = rb_define_module("TMail");
     }
-    MailScanner = rb_define_class_under(TMail, "Scanner_C", rb_cObject);
+    MailScanner = rb_define_class_under(TMail, "MailScanner", rb_cObject);
 
     tmp = rb_str_new2(TMAIL_VERSION);
     rb_obj_freeze(tmp);
@@ -580,3 +580,4 @@ Init_scanner_c()
     tok_id     = cstr2symbol("ID");
     tok_for    = cstr2symbol("FOR");
 }
+

data/lib/tmail/base64.rb

@@ -1,75 +1,52 @@
-=begin rdoc
-
-= Base64 handling class
-
-=end
-#--
-# Copyright (c) 1998-2003 Minero Aoki <aamine@loveruby.net>
+# = TITLE:
 #
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
+#   Base64
 #
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
+# = COPYRIGHT:
 #
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#   Copyright (c) 1998-2003 Minero Aoki <aamine@loveruby.net>
 #
-# Note: Originally licensed under LGPL v2+. Using MIT license for Rails
-# with permission of Minero Aoki.
-#++
-
-require 'tmail/require_arch'
+#   Permission is hereby granted, free of charge, to any person obtaining
+#   a copy of this software and associated documentation files (the
+#   "Software"), to deal in the Software without restriction, including
+#   without limitation the rights to use, copy, modify, merge, publish,
+#   distribute, sublicense, and/or sell copies of the Software, and to
+#   permit persons to whom the Software is furnished to do so, subject to
+#   the following conditions:
+#
+#   The above copyright notice and this permission notice shall be
+#   included in all copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+#   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+#   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+#   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+#   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#   Note: Originally licensed under LGPL v2+. Using MIT license for Rails
+#   with permission of Minero Aoki.
 
+#
 module TMail
 
   module Base64
 
     module_function
 
-    def rb_folding_encode( str, eol = "\n", limit = 60 )
+    def folding_encode( str, eol = "\n", limit = 60 )
       [str].pack('m')
     end
 
-    def rb_encode( str )
+    def encode( str )
       [str].pack('m').tr( "\r\n", '' )
     end
 
-    def rb_decode( str, strict = false )
+    def decode( str, strict = false )
       str.unpack('m').first
     end
 
-    begin
-      require_arch('base64')  #require 'tmail/base64.so'
-      alias folding_encode c_folding_encode
-      alias encode         c_encode
-      alias decode         c_decode
-      class << self
-        alias folding_encode c_folding_encode
-        alias encode         c_encode
-        alias decode         c_decode
-      end
-    rescue LoadError
-      alias folding_encode rb_folding_encode
-      alias encode         rb_encode
-      alias decode         rb_decode
-      class << self
-        alias folding_encode rb_folding_encode
-        alias encode         rb_encode
-        alias decode         rb_decode
-      end
-    end
-
   end
 
 end

data/lib/tmail/encode.rb

@@ -1,36 +1,35 @@
-=begin rdoc
-
-= Text Encoding class
-
-=end
-#--
-# Copyright (c) 1998-2003 Minero Aoki <aamine@loveruby.net>
+# = TITLE:
+#
+#   Text Encoding class
+#
+# = COPYRIGHT:
 #
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
+#   Copyright (c) 1998-2003 Minero Aoki <aamine@loveruby.net>
 #
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
+#   Permission is hereby granted, free of charge, to any person obtaining
+#   a copy of this software and associated documentation files (the
+#   "Software"), to deal in the Software without restriction, including
+#   without limitation the rights to use, copy, modify, merge, publish,
+#   distribute, sublicense, and/or sell copies of the Software, and to
+#   permit persons to whom the Software is furnished to do so, subject to
+#   the following conditions:
 #
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#   The above copyright notice and this permission notice shall be
+#   included in all copies or substantial portions of the Software.
 #
-# Note: Originally licensed under LGPL v2+. Using MIT license for Rails
-# with permission of Minero Aoki.
-#++
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+#   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+#   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+#   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+#   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#   Note: Originally licensed under LGPL v2+. Using MIT license for Rails
+#   with permission of Minero Aoki.
 
 require 'nkf'
-require 'tmail/base64.rb'
+require 'tmail/base64'
 require 'tmail/stringio'
 require 'tmail/utils'
 
@@ -52,25 +51,25 @@ module TMail
       end
     end
     module_function :create_dest
-    
+
     def encoded( eol = "\r\n", charset = 'j', dest = nil )
       accept_strategy Encoder, eol, charset, dest
     end
-    
+
     def decoded( eol = "\n", charset = 'e', dest = nil )
       # Turn the E-Mail into a string and return it with all
       # encoded characters decoded.  alias for to_s
       accept_strategy Decoder, eol, charset, dest
     end
-    
+
     alias to_s decoded
-    
+
     def accept_strategy( klass, eol, charset, dest = nil )
       dest ||= ''
       accept klass.new( create_dest(dest), charset, eol )
       dest
     end
-    
+
   end
 
 
@@ -121,7 +120,7 @@ module TMail
     def header_body( str )
       @f << decode(str)
     end
-      
+
     def space
       @f << ' '
     end
@@ -131,7 +130,7 @@ module TMail
     def lwsp( str )
       @f << str
     end
-      
+
     def meta( str )
       @f << str
     end
@@ -203,7 +202,7 @@ module TMail
     def preserve_quotes=( bool )
       @preserve_quotes
     end
-    
+
     def preserve_quotes
       @preserve_quotes
     end
@@ -379,7 +378,7 @@ module TMail
         i += 1
       end
     end
-    
+
     METHOD_ID = {
       ?j => :extract_J,
       ?e => :extract_E,
@@ -488,7 +487,7 @@ module TMail
       # if it has text, fold there
       # check the remaining text, if too long, fold again
       # if it doesn't, then don't fold unless the line goes beyond 998 chars
-      
+
       # Check the text to see if there is whitespace, or if not
       @wrapped_text = []
       until @text == ''
@@ -500,7 +499,7 @@ module TMail
     def fold_the_string
       whitespace_location = @text =~ /\s/ || @text.length
       # Is the location of the whitespace shorter than the RCF_2822_MAX_LENGTH?
-      # if there is no whitespace in the string, then this 
+      # if there is no whitespace in the string, then this
       unless mazsize(whitespace_location) <= 0
         @wrapped_text << @text.slice!(0...whitespace_location)
       # If it is not less, we have to wrap it destructively