Class: ActionMailer::Preview

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

Class Method Summary collapse

Methods included from ActiveSupport::DescendantsTracker

clear, descendants, descendants, direct_descendants, direct_descendants, inherited, store_inherited

Class Method Details

.allObject

Returns all mailer preview classes.


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

def all
  load_previews if descendants.empty?
  descendants
end

.call(email) ⇒ 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.


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

def call(email)
  preview = self.new
  message = preview.public_send(email)
  inform_preview_interceptors(message)
  message
end

.email_exists?(email) ⇒ Boolean

Returns true if the email exists.

Returns:

  • (Boolean)

77
78
79
# File 'actionmailer/lib/action_mailer/preview.rb', line 77

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

.emailsObject

Returns all of the available email previews.


72
73
74
# File 'actionmailer/lib/action_mailer/preview.rb', line 72

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

.exists?(preview) ⇒ Boolean

Returns true if the preview exists.

Returns:

  • (Boolean)

82
83
84
# File 'actionmailer/lib/action_mailer/preview.rb', line 82

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

.find(preview) ⇒ Object

Find a mailer preview by its underscored class name.


87
88
89
# File 'actionmailer/lib/action_mailer/preview.rb', line 87

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

.preview_nameObject

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


92
93
94
# File 'actionmailer/lib/action_mailer/preview.rb', line 92

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