Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

log::agent::driver::mail(3pm) [debian man page]

Agent::Driver::Mail(3pm)				User Contributed Perl Documentation				  Agent::Driver::Mail(3pm)

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

       Copyright (C) 2002 Mark Rogaski; all rights reserved.

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

SEE ALSO

       Mail::Mailer, Log::Agent::Driver(3), Log::Agent(3).

perl v5.10.0							    2002-05-12						  Agent::Driver::Mail(3pm)

Check Out this Related Man Page

Agent::Tag::Priority(3pm)				User Contributed Perl Documentation				 Agent::Tag::Priority(3pm)

NAME

       Log::Agent::Tag::Priority - a log priority tag string

SYNOPSIS

	Not intended to be used directly
	Inherits from Log::Agent::Tag.

DESCRIPTION

       This class represents a log priority tag string.

CREATION ROUTINE PARAMETERS

       The following parameters are defined, in alphabetical order:

       "-display" => string
	   Specifies the priority/level string to display, with minimal variable substitution.	For instance:

	    -display => '[$priority/$level]'

	   The defined variables are documented in the DISPLAY VARIABLES section underneath.

       "-level" => level
	   This parameter is internally added by "Log::Agent" when computing the priority tag, since only it knows the level of the current
	   messsage.

       "-postfix" => flag
	   Whether tag should be placed after or before the log message.  By default, it is prepended to the log message, i.e. this parameter is
	   false.

       "-priority" => prio
	   This parameter is internally added by "Log::Agent" when computing the priority tag, since only it knows the priority of the current
	   messsage.

       "-separator" => string
	   The separation string between the tag and the log message.  A single space by default.

DISPLAY VARIABLES

       The "-display" switch understands a few variables that can be substituted in the supplied string.  Both $var and "${var}" forms are
       supported.  Unknown variables are left untouched.

       $priority
	   The full priority name of the logged message, e.g. "warning" or "error".

       $level
	   The associated priority level of the logged message, a number.  For instance, the level associated to "warning" is 4.  See
	   Log::Agent::Priorities for the default name -> level mapping.

AUTHOR

       Raphael Manfredi <Raphael_Manfredi@pobox.com>

SEE ALSO

       Log::Agent::Tag(3), Log::Agent::Message(3), Log::Agent::Priorities(3).

perl v5.10.0							    2002-03-09						 Agent::Tag::Priority(3pm)
Man Page