markbates / blabber_mouth

Easy model-like notification system for Ruby. (A framework agnostic port of the mack-notifier package.)

Home Page:http://www.metabates.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This gem provides a simple API for creating emails within a Mack application.

A simple BlabberMouth model would look like this:

  class WelcomeEmail
    include BlabberMouth
  end
  
To use this in your application you would do something like the following:
 
  mail = WelcomeEmail.new
  mail.to = "foo@example.com"
  mail.from = "me@example.com"
  mail.subject = "Hello"
  mail.body(:plain, "This is my plain text body")
  mail.body(:html, "This is my <b>HTML</b> body")
  mail.attach(BlabberMouth::Attachment.new("/path/to/my/image_file.png"))
  mail.attach(BlabberMouth::Attachment.new("/path/to/my/pdf_file.pdf"))
  mail.deliver
  
This gem currently has an adapter for TMail, but it can support any mailing
framework under the covers with the creation of a simple adapter class.

Currently implemented delivery handlers are: SMTP (default), sendmail, and test.

== Testing

When testing you can get access to delivered emails with the delivered_notifiers
method. After each tests these emails will be flushed our of the test handler.

About

Easy model-like notification system for Ruby. (A framework agnostic port of the mack-notifier package.)

http://www.metabates.com

License:MIT License


Languages

Language:Ruby 100.0%