Where do I put helper methods for ActionMailer views?

Question

I have a method that takes an array of strings and joins them so they do something like this:

>> my_arr
=> ["A", "B", "C"]
>> and_join(my_arr)
=> "A, B, and C"

Which I'd like my mailer to have access to so I can output some information into an email. I can't seem to find a good place to put it and putting it in the application_helper.rb file and it doesn't find it there. Where should it go?

Worth looking at the `to_sentence` extension method for arrays that rails provides. — Shadwell, Sep 10 '10 at 08:32
@Shadwell, post that as an answer and I'll +1 it. That is exactly what I was looking for. — aarona, Sep 10 '10 at 18:13
similar one - http://amolnpujari.wordpress.com/2013/12/27/highlight-changes-being-made-on-activerecord-object-inside-mail/ — Amol Pujari, Dec 27 '13 at 11:32

score 74 · Accepted Answer · edited Jun 25 '12 at 13:34

74

Use the helper method in your mailer to define the helper class to use

# mailer_helper.rb
module MailerHelper
  def and_join(arr)
    # whatever …
  end
end

# my_mailer.rb
class MyMailer < ActionMailer::Base
  helper MailerHelper
  …
end

then you can use the methods in views as well.

edited Jun 25 '12 at 13:34

opsidao

1,441
16
23

answered Sep 10 '10 at 01:05

edgerunner

14,873
2
57
69

6

Great. Add `include MailerHelper` to `MyMailer < ActionMailer::Base` as well to use the helper methods in `My Mailer` (like a subject formatter) in addition to any downstream views – Chris Beck Jan 05 '14 at 15:39

score 10 · Answer 2 · answered Sep 10 '10 at 19:54

10

It would be worth looking at the to_sentence extension method for arrays that rails provides.

answered Sep 10 '10 at 19:54

Shadwell

34,314
14
94
99

score 5 · Answer 3 · answered Aug 08 '13 at 10:42

An already answered question, but I didn't get where/what-file to modify from the other SO responses. Here is how I did it:

At the bottom of app/config/initializers/devise.rb you can add this:

Devise::Mailer.class_eval do
  helper :application # includes "ApplicationHelper"
end

This example will include the methods in /app/helpers/application_helper.rb. You could include another helper-file instead - if, for example, the method is only for the mailer or used for one other controller only. The def I needed is used all over, so I put in in that file so all views could access it.

score 5 · Answer 4 · answered Oct 19 '17 at 13:52

In my case, for Rails 5.1, I had to use both include and helper methods, like this:

include ApplicationHelper
helper :application

And then just proceed to use the method normally.

class MyMailer < ActionMailer::Base
  include ApplicationHelper
  helper :application

  def my_mailer_method
    my_helper_method_declared_in_application_helper
    ..
  end
end

score 5 · Answer 5 · answered Jan 24 '19 at 17:32

If you have some one off methods you want to use in the view, you can use helper_method directly in your mailer.

class MyMailer < ApplicationMailer
  def mailer
    mail to: '', subject: ''
  end

  private

  helper_method def something_to_use_in_the_view
  end
end

something_to_use_in_the_view will be available in your view.

score 4 · Answer 6 · answered Jul 21 '11 at 08:26

4

+1, worked fine, just a little correction:

You have to use module instead of class in the helper file:

# mailer_helper.rb
module MailerHelper
  def and_join(arr)
    # whatever …
  end
end

answered Jul 21 '11 at 08:26

viktorvogh

51
1

Where do I put helper methods for ActionMailer views?

6 Answers6

Linked