What is the action mailer layouts plugin?

A Rails plugin to enable layouts for ActionMailer templates.

How do I install it?

The same way you install all Rails plugins. At the root of your Rails app, issue the command:

script/plugin install http://svn.cardboardrocket.com/action_mailer_layouts

How do I use it?

Installing this plugin will add a new 'layout' property to the ActionMailer::Base class. Specify the name of the layout template you want to use. The plugin will look in app/views/layouts for your layout. If no layout is specified, the plugin will look for a layout that matches the name of your mailer class.

If your mailer class is called UserNotifier and you are rendering the activation.rhtml template, then the plugin will attempt to load the user_notifier.rhtml layout. Or, if you are rendering the activation.text.html.rhtml template, the plugin will look for the user_notifier.text.html.rhtml layout.

You can overload this behavior by setting the layout property of your mailer:

class UserNotfier < ActionMailer::Base
  def activation(user)
    @recipients     = user.email
    @from           = 'you@ domain.com'
    @sent_on        = Time.now
    @subject        = 'Activate your account!'
    @layout         = :email
  end
end

This arrangement will cause the plugin to render the content in views/user_notifier/activation.text.html.rhtml in the views/layouts/email.text.html.rhtml layout.

What are the licensing terms?

The plugin is licensed under the MIT License.

I installed the plugin but it's not doing what I expect! Where can I file a bug report?

Directly to me via email.