Class: ActionMailer::Preview

Inherits:
Object
  • Object
show all
Extended by:
ActiveSupport::DescendantsTracker
Defined in:
lib/action_mailer/preview.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Preview

Returns a new instance of Preview.



58
59
60
 
# File 'lib/action_mailer/preview.rb', line 58

def initialize(params = {})
  @params = params
end

Instance Attribute Details

#params ⇒ Object (readonly)

Returns the value of attribute params.



56
57
58
 
# File 'lib/action_mailer/preview.rb', line 56

def params
  @params
end

Class Method Details

.all ⇒ Object

Returns all mailer preview classes.



64
65
66
67
 
# File 'lib/action_mailer/preview.rb', line 64

def all
  load_previews if descendants.empty?
  descendants
end

.call(email, params = {}) ⇒ Object

Returns the mail object for the given email name. The registered preview interceptors will be informed so that they can transform the message as they would if the mail was actually being delivered.



72
73
74
75
76
77
 
# File 'lib/action_mailer/preview.rb', line 72

def call(email, params = {})
  preview = new(params)
  message = preview.public_send(email)
  inform_preview_interceptors(message)
  message
end

.email_exists?(email) ⇒ Boolean

Returns true if the email exists.

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/action_mailer/preview.rb', line 85

def email_exists?(email)
  emails.include?(email)
end

.emails ⇒ Object

Returns all of the available email previews.



80
81
82
 
# File 'lib/action_mailer/preview.rb', line 80

def emails
  public_instance_methods(false).map(&:to_s).sort
end

.exists?(preview) ⇒ Boolean

Returns true if the preview exists.

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/action_mailer/preview.rb', line 90

def exists?(preview)
  all.any? { |p| p.preview_name == preview }
end

.find(preview) ⇒ Object

Find a mailer preview by its underscored class name.



95
96
97
 
# File 'lib/action_mailer/preview.rb', line 95

def find(preview)
  all.find { |p| p.preview_name == preview }
end

.preview_name ⇒ Object

Returns the underscored name of the mailer preview without the suffix.



100
101
102
 
# File 'lib/action_mailer/preview.rb', line 100

def preview_name
  name.sub(/Preview$/, "").underscore
end