906aebceed
Resolved all the conflicts since 2.3.0 -> HEAD. Following is a list of commits that could not be applied cleanly or are obviated with the abstract_controller refactor. They all need to be revisited to ensure that fixes made in 2.3 do not reappear in 3.0: 2259ecf368e6a6715966f69216e3ee86bf1a82a7 AR not available * This will be reimplemented with ActionORM or equivalent 06182ea02e92afad579998aa80144588e8865ac3 implicitly rendering a js response should not use the default layout [#1844 state:resolved] * This will be handled generically 893e9eb99504705419ad6edac14d00e71cef5f12 Improve view rendering performance in development mode and reinstate template recompiling in production [#1909 state:resolved] * We will need to reimplement rails-dev-boost on top of the refactor; the changes here are very implementation specific and cannot be cleanly applied. The following commits are implicated: 199e750d46c04970b5e7684998d09405648ecbd4 3942cb406e1d5db0ac00e03153809cc8dc4cc4db f8ea9f85d4f1e3e6f3b5d895bef6b013aa4b0690 e3b166aab37ddc2fbab030b146eb61713b91bf55 ae9f258e03c9fd5088da12c1c6cd216cc89a01f7 44423126c6f6133a1d9cf1d0832b527e8711d40f 0cb020b4d6d838025859bd60fb8151c8e21b8e84 workaround for picking layouts based on wrong view_paths [#1974 state:resolved] * The specifics of this commit no longer apply. Since it is a two-line commit, we will reimplement this change. 8c5cc66a831aadb159f3daaffa4208064c30af0e make action_controller/layouts pick templates from the current instance's view_paths instead of the class view_paths [#1974 state:resolved] * This does not apply at all. It should be trivial to apply the feature to the reimplemented ActionController::Base. 87e8b162463f13bd50d27398f020769460a770e3 fix HTML fallback for explicit templates [#2052 state:resolved] * There were a number of patches related to this that simply compounded each other. Basically none of them apply cleanly, and the underlying issue needs to be revisited. After discussing the underlying problem with Koz, we will defer these fixes for further discussion. |
||
---|---|---|
.. | ||
lib | ||
test | ||
CHANGELOG | ||
install.rb | ||
MIT-LICENSE | ||
Rakefile | ||
README |
= Action Mailer -- Easy email delivery and testing Action Mailer is a framework for designing email-service layers. These layers are used to consolidate code for sending out forgotten passwords, welcome wishes on signup, invoices for billing, and any other use case that requires a written notification to either a person or another system. Additionally, an Action Mailer class can be used to process incoming email, such as allowing a weblog to accept new posts from an email (which could even have been sent from a phone). == Sending emails The framework works by setting up all the email details, except the body, in methods on the service layer. Subject, recipients, sender, and timestamp are all set up this way. An example of such a method: def signed_up(recipient) recipients recipient subject "[Signed up] Welcome #{recipient}" from "system@loudthinking.com" body :recipient => recipient end The body of the email is created by using an Action View template (regular ERb) that has the content of the body hash parameter available as instance variables. So the corresponding body template for the method above could look like this: Hello there, Mr. <%= @recipient %> And if the recipient was given as "david@loudthinking.com", the email generated would look like this: Date: Sun, 12 Dec 2004 00:00:00 +0100 From: system@loudthinking.com To: david@loudthinking.com Subject: [Signed up] Welcome david@loudthinking.com Hello there, Mr. david@loudthinking.com You never actually call the instance methods like signed_up directly. Instead, you call class methods like deliver_* and create_* that are automatically created for each instance method. So if the signed_up method sat on ApplicationMailer, it would look like this: ApplicationMailer.create_signed_up("david@loudthinking.com") # => tmail object for testing ApplicationMailer.deliver_signed_up("david@loudthinking.com") # sends the email ApplicationMailer.new.signed_up("david@loudthinking.com") # won't work! == Receiving emails To receive emails, you need to implement a public instance method called receive that takes a tmail object as its single parameter. The Action Mailer framework has a corresponding class method, which is also called receive, that accepts a raw, unprocessed email as a string, which it then turns into the tmail object and calls the receive instance method. Example: class Mailman < ActionMailer::Base def receive(email) page = Page.find_by_address(email.to.first) page.emails.create( :subject => email.subject, :body => email.body ) if email.has_attachments? for attachment in email.attachments page.attachments.create({ :file => attachment, :description => email.subject }) end end end end This Mailman can be the target for Postfix or other MTAs. In Rails, you would use the runner in the trivial case like this: ./script/runner 'Mailman.receive(STDIN.read)' However, invoking Rails in the runner for each mail to be received is very resource intensive. A single instance of Rails should be run within a daemon if it is going to be utilized to process more than just a limited number of email. == Configuration The Base class has the full list of configuration options. Here's an example: ActionMailer::Base.smtp_settings = { :address => 'smtp.yourserver.com', # default: localhost :port => '25', # default: 25 :user_name => 'user', :password => 'pass', :authentication => :plain # :plain, :login or :cram_md5 } == Dependencies Action Mailer requires that the Action Pack is either available to be required immediately or is accessible as a GEM. == Bundled software * tmail 0.10.8 by Minero Aoki released under LGPL Read more on http://i.loveruby.net/en/prog/tmail.html * Text::Format 0.63 by Austin Ziegler released under OpenSource Read more on http://www.halostatue.ca/ruby/Text__Format.html == Download The latest version of Action Mailer can be found at * http://rubyforge.org/project/showfiles.php?group_id=361 Documentation can be found at * http://actionmailer.rubyonrails.org == Installation You can install Action Mailer with the following command. % [sudo] ruby install.rb from its distribution directory. == License Action Mailer is released under the MIT license. == Support The Action Mailer homepage is http://www.rubyonrails.org. You can find the Action Mailer RubyForge page at http://rubyforge.org/projects/actionmailer. And as Jim from Rake says: Feel free to submit commits or feature requests. If you send a patch, remember to update the corresponding unit tests. If fact, I prefer new feature to be submitted in the form of new unit tests.