Module: ActionMailer::Previews::ClassMethods

Relationships & Source Files
Defined in:	actionmailer/lib/action_mailer/preview.rb

Instance Attribute Summary

#preview_path rw
#preview_path=(value) rw

Instance Method Summary

#register_preview_interceptor(interceptor)

Register an Interceptor which will be called before mail is previewed.
#register_preview_interceptors(*interceptors)

Register one or more Interceptors which will be called before mail is previewed.
#unregister_preview_interceptor(interceptor)

Unregister a previously registered Interceptor.
#unregister_preview_interceptors(*interceptors)

Unregister one or more previously registered Interceptors.
#interceptor_class_for(interceptor) private

Instance Attribute Details

#preview_path (rw)

[ GitHub ]

# File 'actionmailer/lib/action_mailer/preview.rb', line 45


def preview_path
  ActionMailer.deprecator.warn(<<-MSG.squish)
    Using preview_path option is deprecated and will be removed in Rails 7.2.
    Please use preview_paths instead.
  MSG
  self.preview_paths.first
end

#preview_path=(value) (rw)

[ GitHub ]

# File 'actionmailer/lib/action_mailer/preview.rb', line 37


def preview_path=(value)
  ActionMailer.deprecator.warn(<<-MSG.squish)
    Using preview_path= option is deprecated and will be removed in Rails 7.2.
    Please use preview_paths= instead.
  MSG
  self.preview_paths << value
end

Instance Method Details

#interceptor_class_for(interceptor) (private)

[ GitHub ]

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


def interceptor_class_for(interceptor)
  case interceptor
  when String, Symbol
    interceptor.to_s.camelize.constantize
  else
    interceptor
  end
end

#register_preview_interceptor(interceptor)

Register an Interceptor which will be called before mail is previewed. Either a class or a string can be passed in as the Interceptor. If a string is passed in it will be constantized.

[ GitHub ]

# File 'actionmailer/lib/action_mailer/preview.rb', line 66


def register_preview_interceptor(interceptor)
  preview_interceptor = interceptor_class_for(interceptor)

  unless preview_interceptors.include?(preview_interceptor)
    preview_interceptors << preview_interceptor
  end
end

#register_preview_interceptors(*interceptors)

[ GitHub ]

# File 'actionmailer/lib/action_mailer/preview.rb', line 54


def register_preview_interceptors(*interceptors)
  interceptors.flatten.compact.each { |interceptor| register_preview_interceptor(interceptor) }
end

#unregister_preview_interceptor(interceptor)

Unregister a previously registered Interceptor. Either a class or a string can be passed in as the Interceptor. If a string is passed in it will be constantized.

[ GitHub ]

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


def unregister_preview_interceptor(interceptor)
  preview_interceptors.delete(interceptor_class_for(interceptor))
end

#unregister_preview_interceptors(*interceptors)

Unregister one or more previously registered Interceptors.

[ GitHub ]

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


def unregister_preview_interceptors(*interceptors)
  interceptors.flatten.compact.each { |interceptor| unregister_preview_interceptor(interceptor) }
end