123456789_123456789_123456789_123456789_123456789_

Class: ActionMailer::LogSubscriber

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: ActiveSupport::LogSubscriber
Defined in: actionmailer/lib/action_mailer/log_subscriber.rb

Overview

Implements the ::ActiveSupport::LogSubscriber for logging notifications when email is delivered or received.

Constant Summary

::ActiveSupport::LogSubscriber - Inherited

BLACK, BLUE, BOLD, CLEAR, CYAN, GREEN, MAGENTA, MODES, RED, WHITE, YELLOW

Class Attribute Summary

Class Method Summary

::ActiveSupport::Subscriber - Inherited

.attach_to

Attach the subscriber to a namespace.

.detach_from

Detach the subscriber from a namespace.

.method_added

Adds event subscribers for all new methods added to the class.

.new, .subscribers, .add_event_subscriber, .remove_event_subscriber

Instance Attribute Summary

Instance Method Summary

::ActiveSupport::Subscriber - Inherited

Constructor Details

This class inherits a constructor from ActiveSupport::Subscriber

Instance Method Details

#deliver(event)

An email was delivered.

[ GitHub ]

  
# File 'actionmailer/lib/action_mailer/log_subscriber.rb', line 12

def deliver(event)
  info do
    if exception = event.payload[:exception_object]
      "Failed delivery of mail #{event.payload[:message_id]} error_class=#{exception.class} error_message=#{exception.message.inspect}"
    elsif event.payload[:perform_deliveries]
      "Delivered mail #{event.payload[:message_id]} (#{event.duration.round(1)}ms)"
    else
      "Skipped delivery of mail #{event.payload[:message_id]} as `perform_deliveries` is false"
    end
  end

  debug { event.payload[:mail] }
end

#logger

Use the logger configured for Base.

[ GitHub ]

  
# File 'actionmailer/lib/action_mailer/log_subscriber.rb', line 38

def logger
  ActionMailer::Base.logger
end

#process(event)

An email was generated.

[ GitHub ]

  
# File 'actionmailer/lib/action_mailer/log_subscriber.rb', line 28

def process(event)
  debug do
    mailer = event.payload[:mailer]
    action = event.payload[:action]
    "#{mailer}##{action}: processed outbound mail in #{event.duration.round(1)}ms"
  end
end