Class: Logging::Appenders::Email

### Home Classes Methods

### In Files

- lib/logging/appenders/email.rb

### Parent

Logging::Appender

### Methods

- ::new
- #authentication=
- #close
- #port=
- #to=

### Included Modules

- Logging::Appenders::Buffering

### Files

- History.txt
- README.rdoc

### Class/Module Index

Quicksearch

- Logging
- Logging::Appender
- Logging::Appenders
- Logging::Appenders::Buffering
- Logging::Appenders::Email
- Logging::Appenders::File
- Logging::Appenders::Growl
- Logging::Appenders::IO
- Logging::Appenders::RollingFile
- Logging::Appenders::Stderr
- Logging::Appenders::Stdout
- Logging::Appenders::StringIo
- Logging::Appenders::Syslog
- Logging::ColorScheme
- Logging::Config
- Logging::Config::Configurator
- Logging::Config::Configurator::DSL
- Logging::Config::Configurator::Error
- Logging::Config::Configurator::TopLevelDSL
- Logging::Config::YamlConfigurator
- Logging::Config::YamlConfigurator::Error
- Logging::Layout
- Logging::Layouts
- Logging::Layouts::Basic
- Logging::Layouts::Parseable
- Logging::Layouts::Pattern
- Logging::Logger
- Logging::MappedDiagnosticContext
- Logging::NestedDiagnosticContext
- Logging::Proxy
- Logging::RailsCompat
- Logging::Repository
- Logging::Repository::Singleton
- Logging::RootLogger
- Logging::Stats
- Logging::Stats::Sampler
- Logging::Stats::Tracker
- RSpec
- RSpec::Core
- RSpec::Core::Configuration
- RSpec::LoggingHelper
- RSpec::LoggingHelper
- Spec
- Spec::Runner
- Spec::Runner::Configuration
- Object
- Object::LoggingHelper
- File
- FileUtils
- Hash
- Kernel
- Module
- ReentrantMutex
- String

No matching classes.

# Logging::Appenders::Email

Provides an appender that can send log messages via email to a list of recipients.

### Attributes

address[RW]
authentication[R]
domain[RW]
enable_starttls_auto[RW]
from[RW]
password[RW]
port[R]
subject[RW]
to[R]
user_name[RW]

### Public Class Methods

new( name, :from => 'me@example.com', :to => 'you@example.com', :subject => 'Whoops!' ) click to toggle source

Create a new email appender that will buffer messages and then send them out in batches to the listed recipients. See the options below to configure how emails are sent through you mail server of choice. All the buffering options apply to the email appender.

The following options are required:

    :from - The base filename to use when constructing new log
            filenames.
    :to   - The list of email recipients either as an Array or a comma
            separated list.

The following options are optional:

    :subject   - The subject line for the email.
    :address   - Allows you to use a remote mail server. Just change it
                 from its default "localhost" setting.
    :port      - On the off chance that your mail server doesn't run on
                 port 25, you can change it.
    :domain    - If you need to specify a HELO domain, you can do it here.
    :user_name - If your mail server requires authentication, set the user
                 name in this setting.
    :password  - If your mail server requires authentication, set the
                 password in this setting.
    :authentication - If your mail server requires authentication, you need
                      to specify the authentication type here. This is a
                      symbol and one of :plain (will send the password in
                      the clear), :login (will send password Base64
                      encoded) or :cram_md5 (combines a Challenge/Response
                      mechanism to exchange information and a cryptographic
                      Message Digest 5 algorithm to hash important
                      information)
    :enable_starttls_auto - When set to true, detects if STARTTLS is
                            enabled in your SMTP server and starts to use it.

Example:

Setup an email appender that will buffer messages for up to 1 minute, and only send messages for ERROR and FATAL messages. This example uses Google's SMTP server with authentication to send out messages.

    Logger.appenders.email( 'email',
        :from       => "server@example.com",
        :to         => "developers@example.com",
        :subject    => "Application Error [#{%x(uname -n).strip}]",

        :address    => "smtp.google.com",
        :port       => 443,
        :domain     => "google.com",
        :user_name  => "example",
        :password   => "12345",
        :authentication => :plain,
        :enable_starttls_auto => true,

        :auto_flushing => 200,     # send an email after 200 messages have been buffered
        :flush_period  => 60,      # send an email after one minute
        :level         => :error   # only process log events that are "error" or "fatal"
    )

    # File lib/logging/appenders/email.rb, line 86
    def initialize( name, opts = {} )
      opts[:header] = false
      super(name, opts)

      af = opts.getopt(:buffsize) ||
           opts.getopt(:buffer_size) ||
           100
      configure_buffering({:auto_flushing => af}.merge(opts))

      # get the SMTP parameters
      self.from = opts.getopt :from
      raise ArgumentError, 'Must specify from address' if @from.nil?

      self.to = opts.getopt :to
      raise ArgumentError, 'Must specify recipients' if @to.empty?

      self.subject   = opts.getopt :subject, "Message from #{$0}"
      self.address   = opts.getopt(:server) || opts.getopt(:address) || 'localhost'
      self.port      = opts.getopt(:port, 25)
      self.domain    = opts.getopt(:domain, ENV['HOSTNAME']) || 'localhost.localdomain'
      self.user_name = opts.getopt(:acct) || opts.getopt(:user_name)
      self.password  = opts.getopt(:passwd) || opts.getopt(:password)
      self.enable_starttls_auto = opts.getopt(:enable_starttls_auto, false)
      self.authentication = opts.getopt(:authtype) || opts.getopt(:authentication) || :plain
    end

### Public Instance Methods

authentication=( val ) click to toggle source

If your mail server requires authentication, you need to specify the authentication type here. This is a symbol and one of :plain (will send the password in the clear), :login (will send password Base64 encoded) or :cram_md5 (combines a Challenge/Response mechanism to exchange information and a cryptographic Message Digest 5 algorithm to hash important information)

    # File lib/logging/appenders/email.rb, line 126
    def authentication=( val )
      @authentication = val.to_s.to_sym
    end

close( *args ) click to toggle source

Close the email appender. If the layout contains a foot, it will not be sent as an email.

    # File lib/logging/appenders/email.rb, line 115
    def close( *args )
      super(false)
    end

port=( val ) click to toggle source

On the off chance that your mail server doesn't run on port 25, you can change it.

    # File lib/logging/appenders/email.rb, line 133
    def port=( val )
      @port = Integer(val)
    end

to=( val ) click to toggle source

The list of email recipients. This can either be an Array of recipients or a comma separated list. A single recipient is also valid.

    email.to = ['mike@example.com', 'tony@example.com']
    email.to = 'alicia@example.com'
    email.to = 'bob@example.com, andy@example.com, john@example.com'

    # File lib/logging/appenders/email.rb, line 144
    def to=( val )
      @to = val.respond_to?(:split) ?  val.split(',') : Array(val)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.