1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
#
# Courier::Filter::Logger::Syslog class
#
# (C) 2004-2008 Julian Mehnle <julian@mehnle.net>
# $Id: Syslog.pm 210 2008-03-21 19:30:31Z julian $
#
###############################################################################
=head1 NAME
Courier::Filter::Logger::Syslog - Syslog logger for the Courier::Filter
framework
=cut
package Courier::Filter::Logger::Syslog;
=head1 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,
...
);
=cut
use warnings;
use strict;
use base 'Courier::Filter::Logger::IOHandle';
use constant TRUE => (0 == 0);
use constant FALSE => not TRUE;
=head1 DESCRIPTION
This class is a syslog logger class for use with Courier::Filter and its filter
modules. It is derived from B<Courier::Filter::Logger::IOHandle>.
=cut
# Implementation:
###############################################################################
=head2 Constructor
The following constructor is provided:
=over
=item B<new>: returns I<Courier::Filter::Logger::Syslog>; throws
I<Courier::Error>
Creates a new logger that logs messages to syslog.
=cut
sub new {
my ($class, %options) = @_;
return $class->SUPER::new(
%options,
timestamp => FALSE,
handle => \*STDERR
);
}
=back
=head2 Instance methods
The following instance methods are provided, as inherited from
B<Courier::Filter::Logger::IOHandle>:
=over
=item B<log_error($text)>: throws Perl exceptions
Logs the error message given as C<$text> (a string which may contain newlines).
=item B<log_rejected_message($message, $reason)>: throws Perl exceptions
Logs the B<Courier::Message> given as C<$message> as having been rejected due
to C<$reason> (a string which may contain newlines).
=back
=head1 SEE ALSO
L<Courier::Filter::Logger::IOHandle>, L<Courier::Filter::Logger>,
L<Courier::Filter::Overview>.
For AVAILABILITY, SUPPORT, and LICENSE information, see
L<Courier::Filter::Overview>.
=head1 AUTHOR
Julian Mehnle <julian@mehnle.net>
=cut
TRUE;
|
