RubyGems - mailfactory - Versions diffs - 0.5.0 - Mend

mailfactory 0.5.0

Files changed (4) hide show

data/lib/mailfactory.rb ADDED Viewed

@@ -0,0 +1,309 @@
+# = Overview:
+# A simple to use module for generating RFC compliant MIME mail
+# ---
+# = License:
+# Author:: David Powers
+# Copyright:: May, 2005
+# License:: Ruby License
+# ---
+# = Usage:
+# 	require 'net/smtp'
+# 	require 'rubygems'
+# 	require 'mailfactory'
+#
+#
+# 	mail = MailFactory.new()
+# 	mail.to = "test@test.com"
+# 	mail.from = "sender@sender.com"
+# 	mail.subject = "Here are some files for you!"
+# 	mail.text = "This is what people with plain text mail readers will see"
+# 	mail.html = "A little something <b>special</b> for people with HTML readers"
+# 	mail.attach("/etc/fstab")
+# 	mail.attach("/some/other/file")
+#
+# 	Net::SMTP.start('smtp1.testmailer.com', 25, 'mail.from.domain', fromaddress, password, :cram_md5) { |smtp|
+# 		mail.to = toaddress
+# 		smtp.send_message(mail.to_s(), fromaddress, toaddress)
+# 	}
+require 'base64'
+require 'pathname'
+# try to bring in the mime/types module, make a dummy module if it can't be found
+begin
+	begin
+		require 'rubygems'
+	rescue LoadError
+	end
+	require 'mime/types'
+rescue LoadError
+	module MIME
+		class Types
+			def Types::type_for(filename)
+				return('')
+			end
+		end
+	end
+end
+# An easy class for creating a mail message
+class MailFactory
+	def initialize()
+		@headers = Array.new()
+		@attachments = Array.new()
+		@attachmentboundary = generate_boundary()
+		@bodyboundary = generate_boundary()
+	end
+	# adds a header to the bottom of the headers
+	def add_header(header, value)
+		@headers << "#{header}: #{value}"
+	end
+	# removes the named header - case insensitive
+	def remove_header(header)
+		@headers.each_index() { |i|
+			if(@headers[i] =~ /^#{Regexp.escape(header)}:/i)
+				@headers.delete_at(i)
+			end
+		}
+	end
+	# sets a header (removing any other versions of that header)
+	def set_header(header, value)
+		remove_header(header)
+		add_header(header, value)
+	end
+	def to=(newto)
+		remove_header("To")
+		add_header("To", newto)
+	end
+	def to()
+		return(get_header("To")[0])
+	end
+	def from=(newfrom)
+		remove_header("From")
+		add_header("From", newfrom)
+	end
+	def from()
+		return(get_header("From")[0])
+	end
+	def subject=(newsubject)
+		remove_header("Subject")
+		add_header("Subject", newsubject)
+	end
+	def subject()
+		return(get_header("Subject")[0])
+	end
+	def cc=(newcc)
+		remove_header("CC")
+		add_header("CC", newcc)
+	end
+	def cc()
+		return(get_header("CC")[0])
+	end
+	# sets the plain text body of the message
+	def text=(newtext)
+		@text = newtext
+	end
+	# sets the HTML body of the message. Only the body of the
+	# html should be provided
+	def html=(newhtml)
+		@html = "<html>\n<head>\n<meta content=\"text/html;charset=ISO-8859-1\" http-equiv=\"Content-Type\">\n</head>\n<body bgcolor=\"#ffffff\" text=\"#000000\">\n#{newhtml}\n</body>\n</html>"
+	end
+	# sets the HTML body of the message.  The entire HTML section should be provided
+	def rawhtml=(newhtml)
+		@html = newhtml
+	end
+	# returns the value (or values) of the named header in an array
+	def get_header(header)
+		headers = Array.new()
+		headerregex = /^#{Regexp.escape(header)}:/i
+		@headers.each() { |h|
+			if(headerregex.match(h))
+				headers << h[/^[^:]+:(.*)/i, 1].strip()
+			end
+		}
+		return(headers)
+	end
+	# returns true if the email is multipart
+	def multipart?()
+		if(@attachments.length > 0 or @html != nil)
+			return(true)
+		else
+			return(false)
+		end
+	end
+	# returns a formatted email
+	def to_s()
+		if(get_header("Date").length == 0)
+			add_header("Date", Time.now.strftime("%a, %d %B %Y %H:%M:%S %Z"))
+		end
+		# Add a mime header if we don't already have one and we have multiple parts
+		if(multipart?())
+			if(get_header("MIME-Version").length == 0)
+				add_header("MIME-Version", "1.0")
+			end
+			if(get_header("Content-Type").length == 0)
+				if(@attachments.length == 0)
+					add_header("Content-Type", "multipart/alternative;boundary=\"#{@bodyboundary}\"")
+				else
+					add_header("Content-Type", "multipart/mixed; boundary=\"#{@attachmentboundary}\"")
+				end
+			end
+		end
+		return("#{headers_to_s()}#{body_to_s()}")
+	end
+	# generates a unique boundary string
+	def generate_boundary()
+		randomstring = Array.new()
+		1.upto(25) {
+			whichglyph = rand(100)
+			if(whichglyph < 40)
+				randomstring << (rand(25) + 65).chr()
+			elsif(whichglyph < 70)
+				randomstring << (rand(25) + 97).chr()
+			elsif(whichglyph < 90)
+				randomstring << (rand(10) + 48).chr()
+			elsif(whichglyph < 95)
+				randomstring << '.'
+			else
+				randomstring << '_'
+			end
+		}
+		return("----=_NextPart_#{randomstring.join()}")
+	end
+	# adds an attachment to the mail.  Type may be given as a mime type.  If it
+	# is left off and the MIME::Types module is available it will be determined automagically.
+	def add_attachment(filename, type=nil)
+		attachment = Array.new()
+		attachment[0] = Pathname.new(filename).basename
+		attachment[1] = MIME::Types.type_for(filename).to_s
+		File.open(filename, File::RDONLY) { |fp|
+			attachment[2] = Base64.b64encode(fp.read())
+		}
+		@attachments << attachment
+	end
+	# adds an attachment to the mail as emailfilename.  Type may be given as a mime type.  If it
+	# is left off and the MIME::Types module is available it will be determined automagically.
+	def add_attachment_as(filename, emailfilename, type=nil)
+		attachment = Array.new()
+		attachment[0] = emailfilename
+		attachment[1] = MIME::Types.type_for(filename).to_s
+		File.open(filename, File::RDONLY) { |fp|
+			attachment[2] = Base64.b64encode(fp.read())
+		}
+		@attachments << attachment
+	end
+	alias attach add_attachment
+	alias attach_as add_attachment_as
+protected
+	# returns the @headers as a properly formatted string
+	def headers_to_s()
+		return("#{@headers.join("\r\n")}\r\n\r\n")
+	end
+	# returns the body as a properly formatted string
+	def body_to_s()
+		body = Array.new()
+		# simple message with one part
+		if(!multipart?())
+			return(@text)
+		else
+			body << "This is a multi-part message in MIME format.\r\n\r\n--#{@attachmentboundary}\r\nContent-Type: multipart/alternative; boundary=\"#{@bodyboundary}\""
+			if(@attachments.length > 0)
+				# text part
+				body << "#{buildbodyboundary('text/plain; charset=ISO-8859-1; format=flowed', '7bit')}\r\n\r\n#{@text}"
+				# html part
+				body << "#{buildbodyboundary('text/html; charset=ISO-8859-1', '7bit')}\r\n\r\n#{@html}"
+				body << "--#{@bodyboundary}--"
+				# and, the attachments
+				if(@attachments.length > 0)
+					@attachments.each() { |attachment|
+						body << "#{buildattachmentboundary(attachment[1], 'base64', attachment[0])}\r\n\r\n#{attachment[2]}"
+					}
+					body << "\r\n--#{@attachmentboundary}--"
+				end
+			else
+				# text part
+				body << "#{buildbodyboundary('text/plain; charset=ISO-8859-1; format=flowed', '7bit')}\r\n\r\n#{@text}"
+				# html part
+				body << "#{buildbodyboundary('text/html; charset=ISO-8859-1', '7bit')}\r\n\r\n#{@html}"
+				body << "--#{@bodyboundary}--"
+			end
+			return(body.join("\r\n\r\n"))
+		end
+	end
+	# builds a boundary string for including attachments in the body
+	def buildattachmentboundary(type, encoding, filename)
+		disposition = "\r\nContent-Disposition: inline; filename=\"#{filename}\""
+		return("--#{@attachmentboundary}\r\nContent-Type: #{type}; name=\"#{filename}\"\r\nContent-Transfer-Encoding: #{encoding}#{disposition}")
+	end
+	# builds a boundary string for inclusion in the body of a message
+	def buildbodyboundary(type, encoding)
+		return("--#{@bodyboundary}\r\nContent-Type: #{type}\r\nContent-Transfer-Encoding: #{encoding}")
+	end
+end

data/lib/test.rb ADDED Viewed

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby
+require 'net/smtp'
+require 'rubygems'
+require 'mailfactory'
+mail = MailFactory.new()
+mail.to = "test@test.com"
+mail.from = "sender@sender.com"
+mail.subject = "Here are some files for you!"
+mail.text = "This is what people with plain text mail readers will see"
+mail.html = "A little something <b>special</b> for people with HTML readers"
+mail.attach("/etc/fstab")
+mail.attach("/some/other/file")
+Net::SMTP.start('smtp1.testmailer.com', 25, 'mail.from.domain', fromaddress, password, :cram_md5) { |smtp|
+	mail.to = toaddress
+	smtp.send_message(mail.to_s(), fromaddress, toaddress)
+}

data/tests/test_mailfactory.rb ADDED Viewed

@@ -0,0 +1,96 @@
+#!/usr/local/bin/ruby
+require 'test/unit'
+require '../lib/mailfactory.rb'
+class TC_MailFactory < Test::Unit::TestCase
+	def setup()
+		@mail = MailFactory.new
+	end
+	def test_set_to
+		assert_nothing_raised("exception raised while setting to=") {
+			@mail.to = "test@test.com"
+		}
+		assert_equal(@mail.to, "test@test.com", "to does not equal what it was set to")
+		assert_nothing_raised("exception raised while setting to=") {
+			@mail.to = "test@test2.com"
+		}
+		# count to headers in the final message to make sure we have only one
+		count = 0
+		@mail.to_s().each_line() { |line|
+			if(line =~ /^To:/i)
+				count = count + 1
+			end
+		}
+		assert_equal(1, count, "Count of To: headers expected to be 1, but was #{count}")
+	end
+	def test_set_from
+		assert_nothing_raised("exception raised while setting from=") {
+			@mail.from = "test@test.com"
+		}
+		assert_equal(@mail.from, "test@test.com", "from does not equal what it was set to")
+		assert_nothing_raised("exception raised while setting from=") {
+			@mail.from = "test@test2.com"
+		}
+		# count to headers in the final message to make sure we have only one
+		count = 0
+		@mail.to_s().each_line() { |line|
+			if(line =~ /^From:/i)
+				count = count + 1
+			end
+		}
+		assert_equal(1, count, "Count of From: headers expected to be 1, but was #{count}")
+	end
+	def test_set_subject
+		assert_nothing_raised("exception raised while setting subject=") {
+			@mail.subject = "Test Subject"
+		}
+		assert_equal(@mail.subject, "Test Subject", "subject does not equal what it was set to")
+		assert_nothing_raised("exception raised while setting subject=") {
+			@mail.subject = "A Different Subject"
+		}
+		# count to headers in the final message to make sure we have only one
+		count = 0
+		@mail.to_s().each_line() { |line|
+			if(line =~ /^Subject:/i)
+				count = count + 1
+			end
+		}
+		assert_equal(1, count, "Count of Subject: headers expected to be 1, but was #{count}")
+	end
+	def test_set_header
+		assert_nothing_raised("exception raised while setting arbitrary header") {
+			@mail.set_header("arbitrary", "some value")
+		}
+		assert_equal("some value", @mail.get_header("arbitrary")[0], "arbitrary header does not equal \"some value\"")
+	end
+	def test_boundary_generator
+		1.upto(50) {
+			assert_match(/^----=_NextPart_[a-zA-Z0-9\._]{25}$/, @mail.generate_boundary(), "illegal message boundary generated")
+		}
+	end
+	def test_email
+		@mail.to="test@test.com"
+		@mail.from="test@othertest.com"
+		@mail.subject="This is a test"
+		@mail.text = "This is a test message with\na few\n\nlines."
+	end
+end

metadata ADDED Viewed

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+rubygems_version: 0.8.10
+specification_version: 1
+name: mailfactory
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+date: 2005-05-21
+summary: MailFactory is a pure-ruby MIME mail generator
+require_paths:
+  - lib
+email: david@grayskies.net
+homepage: http://mailfactory.rubyforge.org
+rubyforge_project: mailfactory
+description: "MailFactory is s simple module for producing RFC compliant mail that can include
+  multiple attachments, multiple body parts, and arbitrary headers"
+autorequire: mailfactory
+default_executable:
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement
+  requirements:
+    -
+      - ">"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  version:
+platform: ruby
+authors:
+  - David Powers
+files:
+  - lib/mailfactory.rb
+  - lib/test.rb
+test_files:
+  - tests/test_mailfactory.rb
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies:
+  - !ruby/object:Gem::Dependency
+    name: mime-types
+    version_requirement:
+    version_requirements: !ruby/object:Gem::Version::Requirement
+      requirements:
+        -
+          - ">="
+          - !ruby/object:Gem::Version
+            version: 1.13.1
+      version: