debian man page for courier::filter::logger::syslog

Courier::Filter::Logger::Syslog(3pm)			User Contributed Perl Documentation		      Courier::Filter::Logger::Syslog(3pm)

NAME
       Courier::Filter::Logger::Syslog - Syslog logger for the Courier::Filter framework

SYNOPSIS
	   use Courier::Filter::Logger::Syslog;

	   my $logger = Courier::Filter::Logger::Syslog->new();

	   # For use in an individual filter module:
	   my $module = Courier::Filter::Module::My->new(
	       ...
	       logger => $logger,
	       ...
	   );

	   # For use as a global Courier::Filter logger object:
	   my $filter = Courier::Filter->new(
	       ...
	       logger => $logger,
	       ...
	   );

DESCRIPTION
       This class is a syslog logger class for use with Courier::Filter and its filter modules.  It is derived from
       Courier::Filter::Logger::IOHandle.

   Constructor
       The following constructor is provided:

       new: returns Courier::Filter::Logger::Syslog; throws Courier::Error
	   Creates a new logger that logs messages to syslog.

   Instance methods
       The following instance methods are provided, as inherited from Courier::Filter::Logger::IOHandle:

       log_error($text): throws Perl exceptions
	   Logs the error message given as $text (a string which may contain newlines).

       log_rejected_message($message, $reason): throws Perl exceptions
	   Logs the Courier::Message given as $message as having been rejected due to $reason (a string which may contain newlines).

SEE ALSO
       Courier::Filter::Logger::IOHandle, Courier::Filter::Logger, Courier::Filter::Overview.

       For AVAILABILITY, SUPPORT, and LICENSE information, see Courier::Filter::Overview.

AUTHOR
       Julian Mehnle <julian@mehnle.net>

perl v5.14.2							    2011-12-27				      Courier::Filter::Logger::Syslog(3pm)