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


Courier-Filter documentation Contained in the Courier-Filter distribution.

Index


Code Index:

NAME

Top

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

SYNOPSIS

Top

    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

Top

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

Top

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

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

AUTHOR

Top

Julian Mehnle <julian@mehnle.net>


Courier-Filter documentation Contained in the Courier-Filter distribution.
#
# Courier::Filter::Logger::Syslog class
#
# (C) 2004-2008 Julian Mehnle <julian@mehnle.net>
# $Id: Syslog.pm 210 2008-03-21 19:30:31Z julian $
#
###############################################################################

package Courier::Filter::Logger::Syslog;

use warnings;
use strict;

use base 'Courier::Filter::Logger::IOHandle';

use constant TRUE   => (0 == 0);
use constant FALSE  => not TRUE;

# Implementation:
###############################################################################

sub new {
    my ($class, %options) = @_;
    
    return $class->SUPER::new(
        %options,
        timestamp   => FALSE,
        handle      => \*STDERR
    );
}

TRUE;