email_sender 1.0.2

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.rdoc

@@ -0,0 +1,89 @@
+= EmailSender Library
+
+EmailSender is an easy to use library to send email through SMTP server based on Net::SMTP library.
+
+  require 'email_sender'
+
+  mailer = EmailSender.new(server: "smtp.mail.com", from: "sender@mail.com")
+  mailer.send(to: "receiver@mail.com", subject: "Test mail!", content: "This is a test mail!")
+
+== Usage
+
+You need specified the connection parameters to SMTP server on initialization:
+
+  # simple unsafe connection
+  mailer = EmailSender.new(server: "smtp.mail.com", from: "Sender Name <sender@mail.com>")
+
+  # encripted and authenticated connection
+  mailer = EmailSender.new(server: "smtp.mail.com", port: 465, from: "Sender Name <sender@mail.com>",
+                           enctype: :ssl_tls, authtype: :plain, username: "user.name", password: "secret")
+
+Easier way to using Gmail account:
+
+  # minimal configuration
+  mailer = EmailSender.new_gmail(username: "user.name", password: "secret")
+  mailer = EmailSender.new_gmail(from: "user.name", password: "secret")
+
+  # with full sender name
+  mailer = EmailSender.new_gmail(from: "Sender Name <user.name@gmail.com>", password: "secret")
+
+  # with another sender email address and another domain (non gmail.com) account
+  mailer = EmailSender.new_gmail(from: "Sender Name <sender@othermail.com>",
+                                 username: "user.name@company.com", password: "secret")
+
+You can modify easily the parameters of mailer object:
+
+  mailer = EmailSender.new(server: "smtp.mail.com", from: "sender@mail.com")
+
+  # modify parameters
+  mailer.renew(server: "smtp.mail.com", from: "Sender Name <sender@mail.com>")
+
+  # modify parameters to a Gmail account
+  mailer.renew_gmail(from: "Sender Name <user.name@gmail.com>", password: "secret")
+
+Send the mail to the +:to+, +:cc+ and +:bcc+ addresses with attachment:
+
+  mailer.send(to: "Receiver Name <receiver@mail.com>", subject: "Test mail!",
+              content: "This is a test mail!", attachment: "/path/to/file")
+
+The +:to+, +:cc+ and +:bcc+ keys accept an email address array so you can send the message to many receivers.
+And the +:attachment+ key accepts also file path array so you can attach more file:
+
+  mailer.send(to: ["Receiver Name 1 <receiver1@mail.com>", "Receiver Name 2 <receiver2@mail.com>"],
+              cc: ["Receiver Name 3 <receiver3@mail.com>", "Receiver Name 4 <receiver4@mail.com>"],
+              bcc: [receiver5@mail.com, "receiver6@mail.com", "receiver7@mail.com"],
+              subject: "Test mail!", content: "This is a test mail!",
+              attachment: ["/path/to/file1", "/path/to/file2", "/path/to/file3"])
+
+If there are not specified the +:to+, +:cc+ and +:bcc+ addresses on sending use the initialized default addresses:
+
+  # create a mailer with default addresses
+  mailer = EmailSender.new(server: "smtp.mail.com", from: "Sender Name <user.name@gmail.com>",
+                           to: "Receiver Name 1 <receiver1@mail.com>",
+                           cc: ["Receiver Name 2 <receiver2@mail.com>", "Receiver Name 3 <receiver3@mail.com>"])
+
+  # send email to the default addresses
+  mailer.send(subject: "Test mail!", content: "This is a test mail!")
+
+You can specify the content type which is +'text/plain'+ by default:
+
+  mailer.send(to: "Receiver Name <receiver@mail.com>", subject: "The Ruby programming language",
+              content: "<img src='http://upload.wikimedia.org/wikipedia/commons/7/73/Ruby_logo.svg'/>",
+              conttype: "text/html")
+
+The library has implemented threadsafe and support the character encoded strings of Ruby.
+
+== Installation
+
+  sudo gem install email_sender
+
+== Requirements
+
+ruby1.9.1
+
+== License
+
+Copyright (C) 2012 Peter Bakonyi
+
+EmailSender is free software; you can redistribute it and/or modify it under the terms of the
+GNU Lesser General Public License (LGPL) version 3.0 as published by the Free Software Foundation.

data/VERSION

@@ -0,0 +1 @@
+1.0.2

data/lib/email_sender.rb

@@ -0,0 +1,264 @@
+# EmailSender library - Easy to use email sending library via SMTP
+# Copyright (C) 2012 Péter Bakonyi <bakonyi.peter@gmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License
+# version 3.0 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License version 3.0 for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with the papyrus library. If not, see
+# <http://www.gnu.org/licenses/>.
+
+
+require 'openssl'
+require 'net/smtp'
+
+
+# == Usage
+#   mailer = EmailSender.new(server: "smtp.mail.com", from: "sender@mail.com")
+#   mailer = EmailSender.new(server: "smtp.mail.com", port: 465, from: Sender Name <"sender@mail.com">,
+#     enctype: :ssl_tls, authtype: :plain, username: "user.name", password: "secret")
+#
+#   mailer = EmailSender.new_gmail(username: "user.name", password: "secret")
+#   mailer = EmailSender.new_gmail(from: "Sender Name <user.name@gmail.com>", password: "secret")
+#
+#   mailer.send(to: "receiver@mail.com", subject: "Test mail!", content: "This is a test mail!")
+#   mailer.send(to: "Receiver Name 1 <receiver1@mail.com>", cc: "Receiver Name 2 <receiver2@mail.com>",
+#     subject: "Test mail!", content: "This is a test mail!", attachment: "/path/to/file")
+# See the README for more useful examples!
+class EmailSender
+  # Major version number
+  VERSION_MAJOR = 1
+  # Minor version number
+  VERSION_MINOR = 0
+  # Tiny version number
+  VERSION_TINY  = 2
+  # Version number
+  VERSION_CODE  = (VERSION_MAJOR << 16) | (VERSION_MINOR << 8) | VERSION_TINY
+  # Version string
+  VERSION       = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_TINY}".freeze
+
+  ATTACHMENT_READ_CACHE = 116736 # multiple to 57 #:nodoc:
+
+  Settings = Struct.new(:server, :port, :domain, :esmtp, :enctype, :authtype,
+    :username, :password, :from_addr, :to_addrs, :cc_addrs, :bcc_addrs) #:nodoc:
+
+  # Create a new mailer object and initialize connection parameters to SMTP server.
+  #   +-----------------------------------------------------------------------------------+
+  #   |                             Initialization Parameters                             |
+  #   +------------+-------------------------------------------+--------------------------+
+  #   |Key         |Possible Values                            |Default Value             |
+  #   +------------+-------------------------------------------+--------------------------+
+  #   |:server     |<string>                                   |                          |
+  #   |:port       |<number>                                   |25, 465 or 587            |
+  #   |:domain     |<string>                                   |-> domain of from address |
+  #   |:esmtp      |:enabled/true, :disabled/false             |:enabled                  |
+  #   |:enctype    |:none, :starttls_auto, :starttls, :ssl_tls |:none                     |
+  #   |:authtype   |:none, :plain, :login, :cram_md5           |:none                     |
+  #   |:username   |<string>                                   |nil                       |
+  #   |:password   |<string>                                   |nil                       |
+  #   |:from       |<string>                                   |                          |
+  #   |:to         |<string>, <array of string>                |[]                        |
+  #   |:cc         |<string>, <array of string>                |[]                        |
+  #   |:bcc        |<string>, <array of string>                |[]                        |
+  #   +------------+-------------------------------------------+--------------------------+
+  def initialize(params)
+    renew(params)
+  end
+
+  # Update the connection parameters to SMTP server.
+  # See the ::new method for initialization parameters.
+  def renew(params)
+    settings = Settings.new
+    settings.from_addr = parse_addr(params[:from])
+    settings.to_addrs = parse_addrs(*params[:to])
+    settings.cc_addrs = parse_addrs(*params[:cc])
+    settings.bcc_addrs = parse_addrs(*params[:bcc])
+    settings.domain = params[:domain] || settings.from_addr.last.split('@').last
+    settings.esmtp = params[:esmtp] != :disabled and params[:esmtp] != false
+    settings.enctype = params[:enctype]
+    authtype = params[:authtype]
+    username = params[:username]
+    password = params[:password]
+    if password and username and authtype and authtype != :none
+      settings.authtype = authtype
+      settings.username = username.encode(Encoding::UTF_8)
+      settings.password = password.encode(Encoding::UTF_8)
+    end
+    settings.server = params[:server].encode(Encoding::UTF_8)
+    settings.port = params[:port] || case settings.enctype
+      when :starttls then Net::SMTP.default_submission_port
+      when :ssl_tls then Net::SMTP.default_tls_port
+      else Net::SMTP.default_port
+    end
+    @settings = settings
+  end
+
+  # Create a new mailer object and initialize connection parameters to Gmail server.
+  #   +-----------------------------------------------------------------------------------+
+  #   |                          Gmail Initialization Parameters                          |
+  #   +------------+-------------------------------------------+--------------------------+
+  #   |Key         |Possible Values                            |Default Value             |
+  #   +------------+-------------------------------------------+--------------------------+
+  #   |:username   |<string>                                   |-> from address           |
+  #   |:password   |<string>                                   |                          |
+  #   |:from       |<string>                                   |-> username parameter     |
+  #   |:to         |<string>, <array of string>                |[]                        |
+  #   |:cc         |<string>, <array of string>                |[]                        |
+  #   |:bcc        |<string>, <array of string>                |[]                        |
+  #   +------------+-------------------------------------------+--------------------------+
+  def self.new_gmail(params)
+    instance = allocate()
+    instance.renew_gmail(params)
+    instance
+  end
+
+  # Update the connection parameters to Gmail server.
+  # See the ::new_gmail method for Gmail initialization parameters.
+  def renew_gmail(params)
+    params = params.dup
+    params[:server] = 'smtp.gmail.com'
+    params[:port] = 465
+    params[:domain] = 'gmail.com'
+    params[:esmtp] = :enabled
+    params[:enctype] = :ssl_tls
+    params[:authtype] = :plain
+    username = params[:username]
+    from = params[:from]
+    if username
+      username = username.encode(Encoding::UTF_8)
+      params[:username] = username << '@gmail.com' unless username.include?('@')
+      params[:from] = username unless from
+    end
+    if from
+      from_name, from_addr = parse_addr(from)
+      unless from_addr.include?('@')
+        from_addr << '@gmail.com'
+        params[:from] = from_name ? "#{from_name} <#{from_addr}>" : from_addr
+      end
+      params[:username] = from_addr unless username
+    end
+    renew(params)
+  end
+
+  # Send an email with the specified parameters.
+  #   +-----------------------------------------------------------------------------------+
+  #   |                                Sending Parameters                                 |
+  #   +------------+-------------------------------------------+--------------------------+
+  #   |Key         |Possible Values                            |Default Value             |
+  #   +------------+-------------------------------------------+--------------------------+
+  #   |:to         |<string>, <array of string>                |\   values of             |
+  #   |:cc         |<string>, <array of string>                | >  initialization        |
+  #   |:bcc        |<string>, <array of string>                |/   parameters            |
+  #   |:subject    |<string>                                   |''                        |
+  #   |:content    |<string>                                   |-> subject parameter      |
+  #   |:conttype   |<string>                                   |'text/plain'              |
+  #   |:attachment |<string>, <array of string>                |[]                        |
+  #   +------------+-------------------------------------------+--------------------------+
+  # See the README for more information!
+  def send(params={})
+    settings = @settings
+    subject = params[:subject] || ''
+    content = params[:content] || subject
+    conttype = params[:conttype] || 'text/plain'
+    attachment = *params[:attachment]
+    to = *params[:to]
+    cc = *params[:cc]
+    bcc = *params[:bcc]
+    if to.empty? and cc.empty? and bcc.empty?
+      to_addrs = settings.to_addrs
+      cc_addrs = settings.cc_addrs
+      bcc_addrs = settings.bcc_addrs
+    else
+      to_addrs = parse_addrs(*to)
+      cc_addrs = parse_addrs(*cc)
+      bcc_addrs = parse_addrs(*bcc)
+    end
+    unless to_addrs.empty?
+      subject = subject.encode(Encoding::UTF_8)
+      content = content.encode(Encoding::UTF_8)
+      smtp = Net::SMTP.new(settings.server, settings.port)
+      smtp.disable_starttls
+      smtp.disable_tls
+      case settings.enctype
+        when :starttls_auto then smtp.enable_starttls_auto
+        when :starttls then smtp.enable_starttls
+        when :ssl_tls then smtp.enable_tls
+      end
+      smtp.esmtp = settings.esmtp
+      message_id = nil
+      smtp.start(settings.domain, settings.username, settings.password, settings.authtype) do
+        from_name, from_addr = settings.from_addr
+        smtp.open_message_stream(from_addr, *to_addrs.keys, *cc_addrs.keys, *bcc_addrs.keys) do |stream|
+          now = Time.now
+          random_id = '%04x%04x.%08x.%08x.%08x' % [Process.pid & 0xFFFF, Thread.current.object_id & 0xFFFF,
+            now.tv_sec & 0xFFFF_FFFF, now.tv_nsec, rand(0x1_0000_0000)]
+          message_id = "#{random_id}@#{settings.domain}"
+          boundary = "boundary0_#{random_id}"
+          stream.puts("Message-ID: <#{message_id}>")
+          stream.puts(now.strftime('Date: %a, %d %b %Y %H:%M:%S %z'))
+          stream.puts("From: " << (from_name ? (from_name.ascii_only? ? "#{from_name} <#{from_addr}>" :
+            "=?utf-8?B?#{[from_name].pack('m0')}?= <#{from_addr}>") : from_addr))
+          to_str = ''
+          to_addrs.each do |addr, name|
+            to = name ? "#{name.ascii_only? ? name : "=?utf-8?B?#{[name].pack('m0')}?="} <#{addr}>" : addr
+            to_str << (to_str.empty? ? "To: #{to}" : ",\n\t#{to}")
+          end
+          stream.puts(to_str) unless to_str.empty?
+          cc_str = ''
+          cc_addrs.each do |addr, name|
+            cc = name ? "#{name.ascii_only? ? name : "=?utf-8?B?#{[name].pack('m0')}?="} <#{addr}>" : addr
+            cc_str << (cc_str.empty? ? "CC: #{cc}" : ",\n\t#{cc}")
+          end
+          stream.puts(cc_str) unless cc_str.empty?
+          stream.puts("Subject: " << (subject.ascii_only? ? subject : "=?utf-8?B?#{[subject].pack('m0')}?="))
+          stream.puts("MIME-Version: 1.0")
+          unless attachment.empty?
+            stream.puts("Content-Type: multipart/mixed; boundary=\"#{boundary}\"")
+            stream.puts
+            stream.puts("This is a multi-part message in MIME format.")
+            stream.puts("--#{boundary}")
+          end
+          stream.puts("Content-Type: #{conttype}; charset=#{content.ascii_only? ? 'us-ascii' : 'utf-8'}")
+          stream.puts("Content-Transfer-Encoding: base64")
+          stream.puts
+          stream.print([content].pack('m57'))
+          unless attachment.empty?
+            attachment.each do |file|
+              file = file.encode(Encoding::UTF_8)
+              basename = File.basename(file)
+              filename = basename.ascii_only? ? basename : "=?utf-8?B?#{[basename].pack('m0')}?="
+              stream.puts("--#{boundary}")
+              stream.puts("Content-Type: application/octet-stream; name=\"#{filename}\"")
+              stream.puts("Content-Transfer-Encoding: base64")
+              stream.puts("Content-Disposition: attachment; filename=\"#{filename}\"")
+              stream.puts
+              File.open(file) { |io| stream.print([io.read(ATTACHMENT_READ_CACHE)].pack('m57')) until io.eof? }
+            end
+            stream.puts("--#{boundary}--")
+          end
+        end
+      end
+      message_id
+    end
+  end
+
+private
+  def parse_addr(str)
+    str = str.encode(Encoding::UTF_8)
+    str.scan(/\A\s*(.*?)\s*<([^<]*?)>\s*\z/).first || [nil, (str.strip!; str)]
+  end
+  def parse_addrs(*strs)
+    addrs = {}
+    strs.each do |str|
+      name, addr = parse_addr(str)
+      addrs[addr] = name
+    end
+    addrs
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: email_sender
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Peter Bakonyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-19 00:00:00.000000000 Z
+dependencies: []
+description: EmailSender is a easy to use library to send email through SMTP server
+  based on Net::SMTP library.
+email: bakonyi.peter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- LICENSE
+- VERSION
+- README.rdoc
+- lib/email_sender.rb
+homepage: https://github.com/BPeti/email_sender
+licenses:
+- LGPL-3
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Easy to use library to send email through any SMTP server.
+test_files: []