Log::Dispatch::Email - Base class for objects that send log messages
via email
package Log::Dispatch::Email::MySender
use Log::Dispatch::Email;
use base qw( Log::Dispatch::Email );
sub send_email
{
my $self = shift;
my %p = @_;
# Send email somehow. Message is in $p{message}
}
This module should be used as a base class to implement
Log::Dispatch::* objects that send their log messages via email.
Implementing a subclass simply requires the code shown in the
SYNOPSIS with a real implementation of the send_email() method.
- * new(%p)
-
This method takes a hash of parameters. The following options are
valid:
- * name ($)
-
The name of the object (not the filename!). Required.
- * min_level ($)
-
The minimum logging level this object will accept. See the
Log::Dispatch documentation on Log Levels for more information. Required.
- * max_level ($)
-
The maximum logging level this obejct will accept. See the
Log::Dispatch documentation on Log Levels for more information. This is not
required. By default the maximum is the highest possible level (which
means functionally that the object has no maximum).
- * subject ($)
-
The subject of the email messages which are sent. Defaults to "$0:
log email"
- * to ($ or \@)
-
Either a string or a list reference of strings containing email
addresses. Required.
- * from ($)
-
A string containing an email address. This is optional and may not
work with all mail sending methods.
- * buffered (0 or 1)
-
This determines whether the object sends one email per message it is
given or whether it stores them up and sends them all at once. The
default is to buffer messages.
- * callbacks( \& or [ \&, \&, ... ] )
-
This parameter may be a single subroutine reference or an array
reference of subroutine references. These callbacks will be called in
the order they are given and passed a hash containing the following keys:
( message => $log_message, level => $log_level )
The callbacks are expected to modify the message and then return a
single scalar containing that modified message. These callbacks will
be called when either the log or log_to methods are called and
will only be applied to a given message once.
- * log_message( message => $ )
-
Sends a message to the appropriate output. Generally this shouldn't
be called directly but should be called through the
log() method
(in Log::Dispatch::Output).
- * send_email(%p)
-
This is the method that must be subclassed. For now the only
parameter in the hash is 'message'.
- * flush
-
If the object is buffered, then this method will call the
send_email() method to send the contents of the buffer and then
clear the buffer.
- * DESTROY
-
On destruction, the object will call
flush() to send any pending
email.
Dave Rolsky, <autarch@urth.org>