RubyGems - bulkmail - Versions diffs - 0.2 → 0.3.0 - Mend

bulkmail 0.2 → 0.3.0

Files changed (24) hide show

data/CHANGELOG +17 -1
data/README +18 -20
data/Rakefile +4 -2
data/bin/bulkmail +19 -44
data/doc/rdoc/created.rid +1 -1
data/lib/bulkmail.rb +4 -110
data/lib/bulkmail/dns_mx.rb +18 -0
data/lib/bulkmail/message.rb +103 -0
data/lib/bulkmail/sender.rb +90 -0
data/lib/bulkmail/thread_pool.rb +113 -0
metadata +17 -20
data/doc/rdoc/classes/Array.html +0 -155
data/doc/rdoc/classes/BulkMail.html +0 -310
data/doc/rdoc/classes/String.html +0 -178
data/doc/rdoc/classes/Symbol.html +0 -155
data/doc/rdoc/files/CHANGELOG.html +0 -165
data/doc/rdoc/files/COPYING.html +0 -129
data/doc/rdoc/files/README.html +0 -160
data/doc/rdoc/files/lib/bulkmail_rb.html +0 -108
data/doc/rdoc/fr_class_index.html +0 -30
data/doc/rdoc/fr_file_index.html +0 -30
data/doc/rdoc/fr_method_index.html +0 -35
data/doc/rdoc/index.html +0 -24
data/doc/rdoc/rdoc-style.css +0 -208

data/CHANGELOG CHANGED Viewed

@@ -1,3 +1,19 @@
+*0.3.0*
+* Connecting directly to the recipient's SMTP server.
+* Implemented Sender class that does the actual work.
+* Implemented Message and Message::MultiPart classes for composing messages.
+* Rewritten from the ground up.
+*0.2.1*
+* Added shuffling of addresses.
+* Fixed batch slicing to actually work.
 *0.2*
 * Updated README.
@@ -34,4 +50,4 @@
 * Preliminary content.
-* Created basic project structure.
+* Created basic project structure.

data/README CHANGED Viewed

@@ -1,6 +1,6 @@
-= about bulkmail
+= About Bulkmail
-Bulkmail is a simple bulk mailing utility in Ruby. It takes a content file and a recipients file, and sends the content to each address listed in the recipients file. I wrote it to be as simple as possible, and as a basic alternative to commercial bulk-mailers. The free ones suck.
+Bulkmail is a simple bulk mailing utility in Ruby. It takes a content file and a recipients file, and sends the content to each address listed in the recipients file. Bulkmail sends email by connecting directly to each recipient's SMTP server, and you therefore do not need your own SMTP server in order to send messages.
 == Usage
@@ -11,31 +11,29 @@ Bulkmail is a simple bulk mailing utility in Ruby. It takes a content file and a
 where the options are:
   [--recipients, -r] recipients file name
   [--content, -c] content file name
-  [--subject, -s] subject
   [--from, -f] from
-  [--host, -h] smtp hostname (if none is specified localhost is presumed)
-  [--user, -u] user name (if authentication is needed)
-  [--password, -p] password (if authentication is needed)
-  [--auth, -a] authentication type
-  [--mime, -m] message mime type.
+  [--helo, -h] SMTP HELO domain (most SMTP servers require you to identify with your domain)
-You can also include headers in the content file, provided they are followed by a blank line. For example:
+You should include headers in the content file. Remember that the headers should be followed by a blank link, followed by the message body. For example:
   Subject: My New Thing
+  From: myemail@mydomain.com
   Content-Type: text/html; charset=UTF-8
   <html><body><h1>My New Thing!</h1></body></html>
 === From Ruby
-  BulkMail.send_bulk(sender, recipients, content, headers)
-Where:
-  [sender] is the sender address. This address will also be used as in the form and to headers.
-  [recipients] is an array of email addresses
-  [content] is the message content
-  [headers] is an array containing message headers.
-You can change server settings by using BulkMail.server_settings:
-  BulkMail.server_settings[:host] = 'mail.example.com'
+  msg = BulkMail::Message({
+    :from => 'myemail@mydomain.com',
+    :subject => 'nothing really'
+  }, 'hi there')
+  sender = BulkMail::Sender.new({
+    :list => addresses,
+    :from => 'myemail@mydomain.com',
+    :helo => 'mydomain.com',
+    :message => msg
+  })
+  sender.start

data/Rakefile CHANGED Viewed

@@ -7,7 +7,7 @@ require 'fileutils'
 include FileUtils
 NAME = "bulkmail"
-VERS = "0.2"
+VERS = "0.3.0"
 CLEAN.include ['**/.*.sw?', '*.gem', '.config']
 RDOC_OPTS = ['--quiet', '--title', "Bulkmail Documentation",
   "--opname", "index.html",
@@ -26,7 +26,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.options += RDOC_OPTS
   rdoc.main = "README"
   rdoc.title = "Bulkmail Documentation"
-  rdoc.rdoc_files.add ['README', 'CHANGELOG', 'COPYING', 'lib/*.rb']
+  rdoc.rdoc_files.add ['README', 'CHANGELOG', 'COPYING', 'lib/**/*']
 end
 spec = Gem::Specification.new do |s|
@@ -46,6 +46,8 @@ spec = Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.8.2'
+  s.add_dependency('pNet-DNS')
   s.files = %w(COPYING README Rakefile) + Dir.glob("{bin,doc,lib}/**/*")
   s.require_path = "lib"

data/bin/bulkmail CHANGED Viewed

@@ -1,28 +1,16 @@
 #!/usr/bin/env ruby
+STDERR.reopen "/dev/null", "a"
+# We do this because pNet-DNS throws out a bunch of warnings
 require 'rubygems'
 require 'optparse'
 require 'bulkmail'
-$sender = nil
+$helo = nil
+$from = nil
 $recipients = []
 $content = nil
-$headers = {}
-def parse_file(fn)
-  lines = IO.readlines(fn)
-  while line = lines.shift
-    break if line.empty?
-    if line =~ /^(.+):\s?(.*)$/
-      $headers ||= {}
-      $headers[$1] = $2
-    else
-      lines.unshift(line)
-      break
-    end
-  end
-  $content = lines.join
-end
 opts = OptionParser.new do |opts|
   opts.banner = "Usage: bulkmail <options>"
@@ -30,42 +18,22 @@ opts = OptionParser.new do |opts|
   opts.separator ""
   opts.separator "Options:"
-  opts.on("-h", "--host HOSTNAME", "SMPT host name. Default is localhost.") do |v|
-    BulkMail.server_settings[:host] = v
-  end
-  opts.on("-u", "--user username", "User name (for authentication)") do |v|
-    BulkMail.server_settings[:user] = v
-  end
-  opts.on("-p", "--password password", "Password (for authentication)") do |v|
-    BulkMail.server_settings[:password] = v
-  end
-  opts.on("-a", "--authentication type", "Authentication type") do |v|
-    BulkMail.server_settings[:auth] = v
+  opts.on("-h", "--helo HOSTNAME", "HELO host name.") do |v|
+    $helo = v
   end
   opts.on("-r", "--recipients filename", "Recipients file name") do |v|
-    $recipients = IO.readlines(v).map {|l| l =~ /(.*)(\r\n|\n)$/; $1}
+    $recipients = IO.readlines(v).map {|l| l =~ /(.*)(\r\n|\n)$/ ? $1 : l}.compact
   end
   opts.on("-c", "--content filename", "Content file name") do |v|
-    parse_file(v)
-  end
-  opts.on("-s", "--subject subject", "Subject line") do |v|
-    $headers[:subject] = v
+    $content = IO.read(v)
   end
   opts.on("-f", "--from from", "From address") do |v|
-    $sender = v
+    $from = v
   end
-  opts.on("-m", "--mime type", "MIME type") do |v|
-    $headers[:content_type] = v
-  end
   # No argument, shows at tail.  This will print an options summary.
   # Try it and see!
   opts.on_tail("-?", "--help", "Show this message") do
@@ -98,5 +66,12 @@ end
 trap('INT') {exit}
 puts "Please hold on..."
-$sender ||= $headers['From']
-BulkMail.send_bulk($sender, $recipients, $content, $headers)
+sender = BulkMail::Sender.new({
+  :list => $recipients,
+  :from => $from,
+  :message => $content,
+  :helo => $helo
+})
+sender.start

data/doc/rdoc/created.rid CHANGED Viewed

	@@ -1 +1 @@
1	- ~~Fri~~ ~~Oct~~ 27 11:38:40 +0200 2006
1	+ Mon Nov 06 23:13:08 +0200 2006

data/lib/bulkmail.rb CHANGED Viewed

@@ -1,110 +1,4 @@
-require 'net/smtp'
-# Symbol extensions
-class Symbol
-  # Returns the symbol as a header string
-  def to_header
-    to_s.split('_').map{|w| w.capitalize}.join('-')
-  end
-end
-class String
-  # Returns self
-  def to_header
-    self
-  end
-  # Returns the address part of a recipient
-  def email_addr
-    s = strip
-    return nil if s.empty?
-    s =~ /<(.*)>/ ? $1 : s
-  end
-end
-class Array
-  # Splits the array into smaller arrays of fixed size
-  def split(batch)
-    result = []
-    idx = 0
-    while idx < size
-      result << slice(idx, batch)
-      idx += batch
-    end
-    result
-  end
-end
-class BulkMail
-  @@server_settings = {
-    :host => 'localhost',
-    :port => 25,
-    :helo_domain => nil,
-    :user => nil,
-    :password => nil,
-    :auth => :plain
-  }
-  # Returns the server_settings hash
-  def self.server_settings
-    @@server_settings
-  end
-  LINE_BREAK = "\r\n"
-  HEADER_FMT = "%s: %s\r\n".freeze
-  # Returns the message headers formatted
-  def self.format_headers(headers)
-    headers.inject('') do |m, kv|
-      m << (HEADER_FMT % [kv[0].to_header, kv[1]])
-    end
-  end
-  # Starts an SMTP session and yields
-  def self.smtp
-    Net::SMTP.start(
-      @@server_settings[:host],
-      @@server_settings[:port],
-      @@server_settings[:helo_domain] || @@server_settings[:host],
-      @@server_settings[:user],
-      @@server_settings[:password],
-      @@server_settings[:auth]) do |smtp|
-      yield smtp
-    end
-  end
-  # Sends an email
-  def self.send_message(smtp, from, to, body, headers = nil)
-    if headers && !headers.empty?
-      msg = format_headers(headers)
-    else
-      msg = LINE_BREAK
-    end
-    msg << LINE_BREAK
-    msg << body
-    smtp.send_message msg, from, to
-  end
-  # Sends bulk mail to a large number of recipients.
-  def self.send_bulk(sender, recipients, body, headers)
-    failed = []
-    succeeded = []
-    headers[:from] = headers[:to] = sender
-    recipients = recipients.map {|r| r.email_addr}.compact
-    recipients.split(10).each do |list|
-      begin
-        smtp {|s| send_message(s, sender.email_addr, list, body, headers)}
-        succeeded.concat list
-        puts "Sent message to #{list.join(', ')}"
-      rescue => e
-        failed.concat list
-        puts "Failed to send to #{list.join(', ')}: #{e.message}\r\n#{e.backtrace.first}"
-      end
-    end
-    # log failed addresses
-    unless failed.empty?
-      File.open('failed.bulkmail', 'w') {|f| failed.each {|l|f.puts l}}
-    end
-    puts "Message to sent to #{succeeded.size} of #{recipients.size} recipients"
-  end
-end
+require File.join(File.dirname(__FILE__), 'bulkmail/thread_pool')
+require File.join(File.dirname(__FILE__), 'bulkmail/dns_mx')
+require File.join(File.dirname(__FILE__), 'bulkmail/message')
+require File.join(File.dirname(__FILE__), 'bulkmail/sender')

data/lib/bulkmail/dns_mx.rb ADDED Viewed

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'net/smtp'
+require 'net/dns'
+module BulkMail
+  # Performs a DNS query for a domain's MX records and returns an array
+  # of SMTP servers for the domain ordered by preference. If no records
+  # are found an error is raised.
+  def self.smtp_servers_for_domain(domain)
+    res = Net::DNS::Resolver.new
+    mx = Net::DNS.mx(domain, res, 'IN')
+    if mx
+      mx.sort {|x,y| y.preference <=> x.preference}.map {|rr| rr.exchange}
+    else
+      raise RuntimeError, "Could not locate MX records for domain #{domain}."
+    end
+  end
+end

data/lib/bulkmail/message.rb ADDED Viewed

@@ -0,0 +1,103 @@
+# Symbol extensions
+class Symbol
+  # Returns the symbol as a header string
+  def to_header
+    return @to_header if @to_header
+    s = to_s
+    @to_header = (s.upcase == s) ? s :
+      to_s.split('_').map{|w| w.capitalize}.join('-')
+  end
+end
+class String
+  alias_method :to_header, :to_s
+end
+module BulkMail
+  # The Message class can be used to compose email messages with headers. Usage
+  # is pretty straightforward:
+  #
+  #   m = BulkMail::Message.new({:from => my_email, :subject => 'hello'},
+  #     'Hi there!')
+  class Message
+    attr_accessor :headers, :body
+    DEFAULT_HEADERS = {
+      :mime_version => '1.0'
+    }
+    PLAIN = 'text/plain; charset=UTF-8'.freeze
+    HTML = 'text/html; charset=UTF-8'.freeze
+    # Creates a new message, including the default headers in the message headers.
+    def initialize(headers, body)
+      @headers = DEFAULT_HEADERS.merge(headers)
+      @body = body
+    end
+    LINE_BREAK = "\r\n"
+    HEADER_FMT = "%s: %s\r\n".freeze
+    # Formats the message headers into a string.
+    def self.format_headers(headers)
+      headers.inject('') do |m, kv|
+        if kv[1]
+          m << (HEADER_FMT % [kv[0].to_header, kv[1]])
+        else
+          m
+        end
+      end
+    end
+    # Composes the header and body into a message string.
+    def to_s
+      msg = Message.format_headers(@headers)
+      msg << LINE_BREAK
+      msg << body
+      msg
+    end
+  end
+  # The MultiPart class can be used for composing multi-part messages. For
+  # example:
+  #
+  #   m = BulkMail::Message::MultiPart.new(
+  #     {:from => 'my_email', :subject => 'Hello'}, :alternate)
+  #   m.add_part({:content_type => BulkMail::Message::PLAIN},
+  #     'You are now seeing the plain text version')
+  #   m.add_part({:content_type => BulkMail::Message::HTML},
+  #     '<p>You are now seeing the HTML version</p>')
+  #   puts m.to_s
+  class Message::MultiPart < Message
+    attr_accessor :parts, :multi_type
+    # Initializes a new instance.
+    def initialize(headers, multi_type)
+      super(headers, nil)
+      @multi_type = multi_type
+      @parts = []
+    end
+    # Adds a part to the message.
+    def add_part(headers, body)
+      @parts << Message.new(headers, body)
+    end
+    BOUNDARY = '!!@@##$$'.freeze
+    MULTI_PART_CONTENT_TYPE_FMT = "multipart/%s; charset=UTF-8; boundary=\"#{BOUNDARY}\"".freeze
+    BOUNDARY_LINE = "\r\n--#{BOUNDARY}\r\n".freeze
+    # Composes the parts into an email message.
+    def to_s
+      @headers[:content_type] = MULTI_PART_CONTENT_TYPE_FMT % @multi_type
+      msg = Message.format_headers(@headers)
+      @parts.each do |part|
+        msg << BOUNDARY_LINE
+        msg << part.to_s
+      end
+      msg << BOUNDARY_LINE
+      msg
+    end
+  end
+end