NAME
Email::ARF::Report - interpret Abuse Reporting Format (ARF) messages
VERSION
version 0.000
$Id: /my/pep/Email-ARF/trunk/lib/Email/ARF/Report.pm 31005 2007-03-21T02:10:59.930917Z rjbs $Achtung! Yes, version 0.000. This is a prototype. This module will definitely continue to exist, but maybe the interface will change radically once more people have seen it and tried to use it. Don't rely on its interface to keep you employed, just yet.
SYNOPSIS
my $report = Email::ARF::Report->new($text);DESCRIPTION
METHODS
new
my $report = Email::ARF::Report->new($message);Given either an Email::MIME object or a string containing the text of an email message, this method returns a new Email::ARF::Report object. If the given message source is not a valid report in ARF format, an exception is raised.
original_email
This method returns an Email::Simple object containing the original message to which the report refers. Bear in mind that this message may have been edited by the reporter to remove identifying information.
description
This method returns the human-readable description of the report, taken from the body of the human-readable (first) subpart of the report.
field
my $value = $report->field($field_name);
my @values = $report->field($field_name);This method returns the value for the given field from the second, machine-readable part of the report. In scalar context, it returns the first value for the field.
feedback_type
user_agent
arf_version
These methods are shorthand for retrieving the fields of the same name, except for arf_version, which returns the Version header. It has been renamed to avoid confusion with the universal VERSION method.
SEE ALSO
http://www.shaftek.org/publications/drafts/abuse-report/draft-shafranovich-feedback-report-01.txt
PERL EMAIL PROJECT
This module is maintained by the Perl Email Project
http://emailproject.perl.org/wiki/Email::ARF::Report
AUTHORS
Ricardo SIGNES <rjbs@cpan.org>
COPYRIGHT AND LICENSE
Copyright 2007 by Ricardo SIGNES
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.