actionmailer-javamail 0.1.0

data/History.txt

@@ -0,0 +1,11 @@
+=== 0.1.0 / 2009-05-07
+
+* Initial release 
+  * Support for SMTP and SMTPS (over SSL)
+  * [Experimental] Untested support for Google App Engine
+  * Support for DKIM message signing
+  * Support for authentication
+
+* Coming soon
+  * Google App Engine verification
+  * Unit tests

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+ext/dkim.jar
+init.rb
+lib/action_mailer/java_mail.rb
+lib/java_mail.rb
+lib/java_mail/config.rb
+lib/java_mail/java.rb
+lib/java_mail/mailer.rb
+lib/javamail.rb

data/README.txt

@@ -0,0 +1,86 @@
+= actionmailer-javamail
+
+== DESCRIPTION:
+
+ActionMailer-JavaMail allows the emails to be delivered via the JavaMail library.  This allows to 
+expand the capabilities of ActionMailer in the jRuby environment via existing JavaMail capabilities.   
+
+The current capabilities are only implemented to send outgoing email without any support for incoming email.
+
+Action Mailer is the part of the Ruby on Rails framework that's designing email-service layers. 
+
+== FEATURES/PROBLEMS:
+
+* Support for SMTP, SMTPS
+* Support for DKIM message signing
+* [Untested] Support for using Google App Engine 
+* [Problem] No unit tests
+
+== REQUIREMENTS:
+
+* ActionMailer 2.3.2 
+* JavaMail libraries in your CLASSPATH  
+
+== INSTALL:
+
+* sudo gem install actionmailer-javamail 
+
+== CONFIGURATION:
+
+In your config/environment.rb, add the following:
+
+  config.gem "actionmailer-javamail", :lib => 'java_mail' if defined?(JRUBY_VERSION)
+
+In one of your config/initializer files, add the following:
+
+  ActionMailer::Base.delivery_method = :javamail
+  ActionMailer::Base.javamail_settings = {
+    :protocol  => :smtps,
+    :address   => 'smtp.gmail.com',
+    :port      => 465,
+    :domain    => 'mydomain.com',
+    :user_name => 'user@gmail.com',
+    :password  => 'password',
+    :dkim      => { :domain => 'mydomain.com', :selector => 'mysel', :key_file => KEY_FILE_PATH } 
+  }
+
+  :protocol  - the possible values are :smtp, :smtps, :none. (:none is used for an preconfigured JavaMail)
+  :address   - allows you to use a remote server
+  :port      - currently a required option for SMTP port
+  :domain    - domain to be specified in HELO command
+  :user_name - user_name for server authentication
+  :password  - password for server authentication
+  :dkim      - (optional) arguments for DKIM signing. Key file needs to be in DER format 
+
+== REFERENCES:
+
+  * The gem includes a copy of DKIM message signing library
+    http://dkim-javamail.sourceforge.net 
+
+  * The following patch was applied to the library
+    http://gist.github.com/108966
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009  Michael Rykov 
+
+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.

data/Rakefile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/java_mail.rb'
+
+Hoe.new('actionmailer-javamail', JavaMail::VERSION) do |p|
+  p.rubyforge_name = 'am-javamail'
+  p.developer('Michael Rykov', 'mrykov@gmail.com')
+  p.url = 'http://github.com/rykov/actionmailer-javamail'
+  p.blog_categories = ['actionmailer-javamail', 'actionmailer', 'javamail', 'jruby', 'rails', 'ruby', 'java']
+end
+
+# vim: syntax=Ruby

data/init.rb

@@ -0,0 +1 @@
+require 'java_mail' if defined?(JRUBY_VERSION)

data/lib/action_mailer/java_mail.rb

@@ -0,0 +1,14 @@
+module ActionMailer
+  module JavaMail
+    def self.included(base) #:nodoc:
+      base.cattr_accessor :javamail_settings
+      base.javamail_settings = {}
+    end
+    
+    def perform_delivery_javamail(mail)
+      ::JavaMail::Mailer.open(javamail_settings) do |mailer|
+        mailer.send_message(mail)
+      end
+    end
+  end
+end

data/lib/java_mail.rb

@@ -0,0 +1,46 @@
+#--
+# Copyright (c) 2009 Michael Rykov 
+#
+# 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.
+#++
+
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'java'
+
+module JavaMail
+  VERSION = '0.1.0'
+
+  unless defined?(JAVAMAIL_HOME)
+    JAVAMAIL_HOME = File.expand_path(File.dirname(__FILE__) + '/..')
+  end
+
+  # wraps all native exceptions
+  class JavaMailError < RuntimeError; end
+end
+
+require 'java_mail/java'
+require 'java_mail/config'
+require 'java_mail/mailer'
+
+if defined?(ActionMailer::Base)
+  require 'action_mailer/java_mail'
+  ActionMailer::Base.send(:include, ActionMailer::JavaMail)
+end

data/lib/java_mail/config.rb

@@ -0,0 +1,62 @@
+module JavaMail
+  class Config
+    def initialize(settings = {})
+      @settings = settings
+      @settings[:protocol] ||= :none
+      
+      unless [:smtp, :smtps, :none].include?(@settings[:protocol])
+        raise JavaMailError.new("Invalid protocol #{@settings[:protocol].to_s}")
+      end
+    end
+    
+    def session_properties
+      props = java.util.Properties.new()
+      return props if @mode == :none
+      
+      # We only support SMTP (plan and SSL) for now
+      props.put('mail.transport.protocol', @settings[:protocol].to_s);
+      
+      # Let's do the basic mapping for SMTP settings
+      session_property_key_map.each_pair do |key, property|
+        props.put(property, @settings[key].to_s) if @settings[key]
+      end
+      
+      # Enable authentication and encryption
+      props.put('mail.smtp.auth', 'true') if self.auth?
+      props.put('mail.smtp.ssl.protocols', 'SSLv3 TLSv1') if @settings[:protocol] == :smtps;
+      
+      # Debugging
+      props.put('mail.debug', 'true') if self.debug?
+      
+      # Return
+      props
+    end
+    
+    def debug?
+      @settings[:debug] ? true : false
+    end
+    
+    def dkim?
+      @settings[:dkim] && @settings[:dkim][:domain] && @settings[:dkim][:selector] && @settings[:dkim][:key_file]
+    end
+    
+    def auth?
+      @settings[:user_name] && @settings[:password]
+    end
+    
+    [:address, :user_name, :password, :port, :dkim].each do |attr|
+      self.class_eval "def #{attr.to_s}; @settings[:#{attr}]; end"
+    end
+  
+  protected
+    def session_property_key_map
+      @@key_map ||= { 
+        :address   => 'mail.smtp.host',
+        :port      => 'mail.smtp.port',
+        :domain    => 'mail.smtp.localhost',
+        :user_name => 'mail.smtp.user',
+        :enable_starttls_auto => 'mail.smtp.starttls.enable'
+      }
+    end
+  end
+end

data/lib/java_mail/java.rb

@@ -0,0 +1,9 @@
+module JavaMail
+  module Java
+    require 'java' 
+    Dir["#{JavaMail::JAVAMAIL_HOME}/ext/**/*.jar"].sort.each {|l| require l}
+    include_package "javax.mail"
+    include_package "javax.mail.internet"
+    include_package "de.agitos.dkim"
+  end
+end

data/lib/java_mail/mailer.rb

@@ -0,0 +1,64 @@
+module JavaMail
+  class Mailer
+    def initialize(settings = {})
+      @config = JavaMail::Config.new(settings)
+      @session = JavaMail::Java::Session.getInstance(@config.session_properties)
+      @session.setDebug(@config.debug?)      
+      @transport = @session.getTransport
+    end
+    
+    def self.open(settings, &block)
+      self.new(settings).open(&block)
+    end
+    
+    def open(&block)
+      begin
+        open_transport unless transport_ready?
+        block.call(self)
+      rescue Exception => e
+        raise JavaMail::JavaMailError.new(e)
+      ensure
+        close_transport if transport_ready?
+      end 
+    end
+    
+    def send_message(tmail)
+      raise JavaMail::JavaMailError.new("JavaMail Transport is not connected") unless transport_ready?
+      send_message_to_transport(tmail, @transport)
+    end
+      
+  protected
+    def transport_ready?
+      @transport && @transport.connected?
+    end
+  
+    def open_transport
+      @transport.connect(@config.address, @config.port.to_i, @config.user_name, @config.password)
+    end
+    
+    def close_transport
+      @transport.close
+    end
+  
+    def send_message_to_transport(tmail, transport)
+      # Dump TMail into ByteArray
+      io_obj = java.io.ByteArrayInputStream.new(tmail.encoded.to_java_bytes)
+
+      # Convert message ByteArray to MimeMessage
+      msg = if @config.dkim?
+        dkimSigner = JavaMail::Java::DKIMSigner.new(@config.dkim[:domain], @config.dkim[:selector], @config.dkim[:key_file]);
+        JavaMail::Java::SMTPDKIMMessage.new(@session, io_obj, dkimSigner);
+      else
+        JavaMail::Java::MimeMessage.new(@session, io_obj);
+      end
+      
+      # Convert recipients to InternetAddress java array
+      recipients = tmail.to_addrs([]).map do |addy| 
+        JavaMail::Java::InternetAddress.new(addy.address) 
+      end.to_java(JavaMail::Java::InternetAddress)
+
+      # Send message
+      transport.sendMessage(msg, recipients)
+    end
+  end
+end

data/lib/javamail.rb

@@ -0,0 +1 @@
+require 'java_mail'

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+extensions: []
+
+homepage: http://github.com/rykov/actionmailer-javamail
+executables: []
+
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+post_install_message: 
+date: 2009-05-10 07:00:00 +00:00
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- ext/dkim.jar
+- init.rb
+- lib/action_mailer/java_mail.rb
+- lib/java_mail.rb
+- lib/java_mail/config.rb
+- lib/java_mail/java.rb
+- lib/java_mail/mailer.rb
+- lib/javamail.rb
+rubygems_version: 1.3.1
+rdoc_options: 
+- --main
+- README.txt
+signing_key: 
+cert_chain: []
+
+name: actionmailer-javamail
+has_rdoc: true
+platform: ruby
+summary: ActionMailer-JavaMail allows the emails to be delivered via the JavaMail
+  library
+default_executable: 
+bindir: bin
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  version: 
+  requirements: 
+  - - '>='
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement 
+  version: 
+  requirements: 
+  - - '>='
+    - !ruby/object:Gem::Version 
+      version: "0"
+require_paths: 
+- lib
+- ext
+specification_version: 2
+test_files: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    version: 
+    requirements: 
+    - - '>='
+      - !ruby/object:Gem::Version 
+        version: 1.12.2
+description: ActionMailer-JavaMail allows the emails to be delivered via the JavaMail
+  library.  This allows to  expand the capabilities of ActionMailer in the jRuby environment
+  via existing JavaMail capabilities.     The current capabilities are only implemented
+  to send outgoing email without any support for incoming email.  Action Mailer is
+  the part of the Ruby on Rails framework that's designing email-service layers.
+email: 
+- mrykov@gmail.com
+authors: 
+- Michael Rykov
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+requirements: []
+
+rubyforge_project: am-javamail
+autorequire: