NAME

Log::Agent::Driver::Mail - email driver for Log::Agent

SYNOPSIS

 use Log::Agent;
 require Log::Agent::Driver::Mail;

 my $driver = Log::Agent::Driver::Mail->make(
     -to      => 'oncall@example.org',
     -cc      => [ qw( noc@example.org admin@example,net ) ],
     -subject => "ALERT! ALERT!",
     -mailer  => [ 'smtp', Server => 'mail.example.net' ]
 );
 logconfig(-driver => $driver);

DESCRIPTION

This driver maps the logxxx() calls to email messages. Each call generates a separate email message. The Mail::Mailer module is required.

CONSTRUCTOR

make OPTIONS

The OPTIONS argument is a hash with the following keys:

-prefix: An optional prefix for the message body.
-to: The destination addresses, may be a scalar containing a valid email address or a reference to an array of addresses.
-reply_to: The reply-to addresses, may be a scalar containing a valid email address or a reference to an array of addresses.
-from: The source address, must be a scalar containing a valid email address.
-subject: The subject line of the email message.
-cc: The carbon copy addresses, may be a scalar containing a valid email address or a reference to an array of addresses.
-bcc: The blind carbon copy addresses, may be a scalar containing a valid email address or a reference to an array of addresses.
-priority: The priority level for the email message. This is NOT related to the logging priority.
-mailer: A reference to an array containing the optional arguments to Mail::Mailer->new(). Generally, this can be omitted.

NOTES

Thanks to Shirley Wang for the idea for this module.

AUTHOR

Mark Rogaski <mrogaski@pobox.com>

LICENSE

See the Log::Agent(3) manpage or the README file included with the distribution for license information.