Module: Roda::RodaPlugins::ErrorMail

Defined in:
lib/roda/plugins/error_mail.rb

Overview

The error_mail plugin adds an error_mail instance method that send an email related to the exception. This is most useful if you are also using the error_handler plugin:

plugin :error_mail, to: '[email protected]', from: '[email protected]'
plugin :error_handler do |e|
  error_mail(e)
  'Internal Server Error'
end

It is similar to the error_email plugin, except that it uses the mail library instead of net/smtp directly. If you are already using the mail library in your application, it makes sense to use error_mail instead of error_email.

Options:

:filter

Callable called with the key and value for each parameter, environment variable, and session value. If it returns true, the value of the parameter is filtered in the email.

:from

The From address to use in the email (required)

:headers

A hash of additional headers to use in the email (default: empty hash)

:prefix

A prefix to use in the email’s subject line (default: no prefix)

:to

The To address to use in the email (required)

The subject of the error email shows the exception class and message. The body of the error email shows the backtrace of the error and the request environment, as well the request params and session variables (if any). You can also call error_mail with a plain string instead of an exception, in which case the string is used as the subject, and no backtrace is included.

Note that emailing on every error as shown above is only appropriate for low traffic web applications. For high traffic web applications, use an error reporting service instead of this plugin.

Defined Under Namespace

Modules: InstanceMethods

Class Method Summary collapse

Class Method Details

.configure(app, opts = OPTS) ⇒ Object

Set default opts for plugin. See ErrorEmail module RDoc for options.



46
47
48
49
50
51
 
# File 'lib/roda/plugins/error_mail.rb', line 46

def self.configure(app, opts=OPTS)
  app.opts[:error_mail] = email_opts = (app.opts[:error_mail] || {:filter=>DEFAULT_FILTER}).merge(opts).freeze
  unless email_opts[:to] && email_opts[:from]
    raise RodaError, "must provide :to and :from options to error_mail plugin"
  end
end