markbates / mack-more
- Source
- Commits
- Network (2)
- Issues (0)
- Downloads (0)
- Wiki (1)
- Graphs
-
Tree:
663e2ae
commit 663e2aec4d98fd1ac45d4e4fc47675783983eb64
tree ebfe711fcb3bdf582509ce22972aa8e999a159e6
parent 8e8b15a1dc9c39c925c7bc1c94f87fb1c568c9b1
tree ebfe711fcb3bdf582509ce22972aa8e999a159e6
parent 8e8b15a1dc9c39c925c7bc1c94f87fb1c568c9b1
mack-more / mack-notifier
mack-notifier/README
This gem provides a simple API for creating emails within a Mack application.
A simple Mack::Notifier model would look like this:
class WelcomeEmail
include Mack::Notifier
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(Mack::Notifier::Attachment.new("/path/to/my/image_file.png"))
mail.attach(Mack::Notifier::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.
== Rake tasks
# Generates a notifier model, a test, and text and html template files.
rake generate:notifier

