actionmailer_extensions 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,6 +1,44 @@
 = actionmailer_extensions
 
-Description goes here.
+These extensions wrap around the "deliver!" method on ActionMailer::Base to provide:
+* save all outgoing emails to disk, and
+* a list of recipient email addresses that are safe to receive mail. All other mail is not sent.
+
+== Saving email to disk
+
+Sending email with markup from a web app is a pain in the ass because HTML markup renders differently in every
+email client. (If you don't believe me, check out this {matrix of CSS support across the different email clients}[http://www.campaignmonitor.com/css/?utm_medium=email&utm_source=Email%20marketing%20software&utm_content=299578507&utm_campaign=September+News+-+Version+A+_+khihur&utm_term=AllnewCSSguidecovering24emailclients].
+
+The only foolproof way to ensure that your content is rendering properly is to visually inspect the emails yourself. To get going, configure ActionMailer like so:
+
+  require 'actionmailer_extensions'
+  ActionMailer::Base.save_emails_to_disk  = true          # Defaults to false
+  ActionMailer::Base.email_output_dir     = "some/path"   # Defaults to "/tmp/actionmailer_output_emails"
+  
+Then send some emails with ActionMailer, and inspect the files in the output path that you specified. The emails are saved with a .eml extension which should open in your favourite email client for easy visual inspection.
+
+== Safe recipients list
+
+Ever found that you want to limit the list of people that can receive email from a Rails app? This is a particularly handy feature during development when you don't want your (unfinished) application to send out real mail to people beyond the dev team.
+
+Configure ActionMailer like so:
+
+  require 'actionmailer_extensions'
+  ActionMailer::Base.safe_recipients = ["pete@example.com", "dave@foo.com"]
+
+Pete and Dave are now the *only* recipients that ActionMailer will send to, and all other mail will be quietly dropped. (And logged to disk, if save_emails_to_disk is enabled.)
+
+Make sure that the recipients list contains the :any symbol in production mode.
+
+  ActionMailer::Base.safe_recipients = [:any]
+
+This is enabled by default. Also note that an empty or nil recipients list means no mail will be sent out to anyone.
+
+== Install
+
+  gem source --add http://gemcutter.org
+  gem install actionmailer_extensions
+
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: actionmailer_extensions
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Peter MacRobert
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-20 00:00:00 +00:00
+date: 2010-02-21 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency