Files
scripts/Perl OTRS/Kernel/cpan-lib/Sisimai/Bite/Email/Bigfoot.pm
2024-10-14 00:08:40 +02:00

236 lines
8.7 KiB
Perl

package Sisimai::Bite::Email::Bigfoot;
use parent 'Sisimai::Bite::Email';
use feature ':5.10';
use strict;
use warnings;
my $Indicators = __PACKAGE__->INDICATORS;
my $StartingOf = { 'rfc822' => ['Content-Type: message/partial'] };
my $MarkingsOf = { 'message' => qr/\A[ \t]+[-]+[ \t]*Transcript of session follows/ };
sub description { 'Bigfoot: http://www.bigfoot.com' }
sub scan {
# Detect an error from Bigfoot
# @param [Hash] mhead Message headers of a bounce email
# @options mhead [String] from From header
# @options mhead [String] date Date header
# @options mhead [String] subject Subject header
# @options mhead [Array] received Received headers
# @options mhead [String] others Other required headers
# @param [String] mbody Message body of a bounce email
# @return [Hash, Undef] Bounce data list and message/rfc822 part
# or Undef if it failed to parse or the
# arguments are missing
# @since v4.1.10
my $class = shift;
my $mhead = shift // return undef;
my $mbody = shift // return undef;
my $match = 0;
# 'subject' => qr/\AReturned mail: /,
$match ||= 1 if rindex($mhead->{'from'}, '@bigfoot.com>') > -1;
$match ||= 1 if grep { rindex($_, '.bigfoot.com ') > -1 } @{ $mhead->{'received'} };
return undef unless $match;
my $dscontents = [__PACKAGE__->DELIVERYSTATUS];
my @hasdivided = split("\n", $$mbody);
my $rfc822part = ''; # (String) message/rfc822-headers part
my $rfc822list = []; # (Array) Each line in message/rfc822 part string
my $blanklines = 0; # (Integer) The number of blank lines
my $readcursor = 0; # (Integer) Points the current cursor position
my $recipients = 0; # (Integer) The number of 'Final-Recipient' header
my $commandtxt = ''; # (String) SMTP Command name begin with the string '>>>'
my $esmtpreply = ''; # (String) Reply from remote server on SMTP session
my $connvalues = 0; # (Integer) Flag, 1 if all the value of $connheader have been set
my $connheader = {
'date' => '', # The value of Arrival-Date header
'lhost' => '', # The value of Reporting-MTA header
};
my $v = undef;
my $p = '';
for my $e ( @hasdivided ) {
# Read each line between the start of the message and the start of rfc822 part.
unless( $readcursor ) {
# Beginning of the bounce message or delivery status part
if( $e =~ $MarkingsOf->{'message'} ) {
$readcursor |= $Indicators->{'deliverystatus'};
next;
}
}
unless( $readcursor & $Indicators->{'message-rfc822'} ) {
# Beginning of the original message part
if( index($e, $StartingOf->{'rfc822'}->[0]) == 0 ) {
$readcursor |= $Indicators->{'message-rfc822'};
next;
}
}
if( $readcursor & $Indicators->{'message-rfc822'} ) {
# After "message/rfc822"
unless( length $e ) {
$blanklines++;
last if $blanklines > 1;
next;
}
push @$rfc822list, $e;
} else {
# Before "message/rfc822"
next unless $readcursor & $Indicators->{'deliverystatus'};
next unless length $e;
if( $connvalues == scalar(keys %$connheader) ) {
# Final-Recipient: RFC822; <destinaion@example.net>
# Action: failed
# Status: 5.7.1
# Remote-MTA: DNS; p01c11m075.mx.example.net
# Diagnostic-Code: SMTP; 553 Invalid recipient destinaion@example.net (Mode: normal)
# Last-Attempt-Date: Sun, 28 Dec 2014 18:17:16 -0800
$v = $dscontents->[-1];
if( $e =~ /\AFinal-Recipient:[ ]*(?:RFC|rfc)822;[ ]*([^ ]+)\z/ ) {
# Final-Recipient: RFC822; <destinaion@example.net>
if( $v->{'recipient'} ) {
# There are multiple recipient addresses in the message body.
push @$dscontents, __PACKAGE__->DELIVERYSTATUS;
$v = $dscontents->[-1];
}
$v->{'recipient'} = Sisimai::Address->s3s4($1);
$recipients++;
} elsif( $e =~ /\AAction:[ ]*(.+)\z/ ) {
# Action: failed
$v->{'action'} = lc $1;
} elsif( $e =~ /\AStatus:[ ]*(\d[.]\d+[.]\d+)/ ) {
# Status: 5.7.1
$v->{'status'} = $1;
} elsif( $e =~ /\ARemote-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/ ) {
# Remote-MTA: DNS; p01c11m075.mx.example.net
$v->{'rhost'} = lc $1;
} else {
# Get error message
if( $e =~ /\ADiagnostic-Code:[ ]*(.+?);[ ]*(.+)\z/ ) {
# Diagnostic-Code: SMTP; 553 Invalid recipient destinaion@example.net (Mode: normal)
$v->{'spec'} = uc $1;
$v->{'diagnosis'} = $2;
} elsif( index($p, 'Diagnostic-Code:') == 0 && $e =~ /\A[ \t]+(.+)\z/ ) {
# Continued line of the value of Diagnostic-Code header
$v->{'diagnosis'} .= ' '.$1;
$e = 'Diagnostic-Code: '.$e;
}
}
} else {
# ----- Transcript of session follows -----
# >>> RCPT TO:<destinaion@example.net>
# <<< 553 Invalid recipient destinaion@example.net (Mode: normal)
#
# --201412281816847
# Content-Type: message/delivery-status
#
# Reporting-MTA: dns; litemail57.bigfoot.com
# Arrival-Date: Sun, 28 Dec 2014 18:17:16 -0800
#
if( $e =~ /\AReporting-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/ ) {
# Reporting-MTA: dns; mx.example.jp
next if $connheader->{'lhost'};
$connheader->{'lhost'} = lc $1;
$connvalues++;
} elsif( $e =~ /\AArrival-Date:[ ]*(.+)\z/ ) {
# Arrival-Date: Wed, 29 Apr 2009 16:03:18 +0900
next if $connheader->{'date'};
$connheader->{'date'} = $1;
$connvalues++;
} else {
# ----- Transcript of session follows -----
# >>> RCPT TO:<destinaion@example.net>
# <<< 553 Invalid recipient destinaion@example.net (Mode: normal)
if( $e =~ /\A[>]{3}[ ]+([A-Z]{4})[ ]?/ ) {
# >>> DATA
$commandtxt = $1;
} elsif( $e =~ /\A[<]{3}[ ]+(.+)\z/ ) {
# <<< Response
$esmtpreply = $1;
}
}
}
} # End of if: rfc822
} continue {
# Save the current line for the next loop
$p = $e;
}
return undef unless $recipients;
for my $e ( @$dscontents ) {
# Set default values if each value is empty.
map { $e->{ $_ } ||= $connheader->{ $_ } || '' } keys %$connheader;
$e->{'diagnosis'} = Sisimai::String->sweep($e->{'diagnosis'});
$e->{'command'} ||= $commandtxt || '';
$e->{'command'} ||= 'EHLO' if $esmtpreply;
$e->{'agent'} = __PACKAGE__->smtpagent;
}
$rfc822part = Sisimai::RFC5322->weedout($rfc822list);
return { 'ds' => $dscontents, 'rfc822' => $$rfc822part };
}
1;
__END__
=encoding utf-8
=head1 NAME
Sisimai::Bite::Email::Bigfoot - bounce mail parser class for C<Bigfoot>.
=head1 SYNOPSIS
use Sisimai::Bite::Email::Bigfoot;
=head1 DESCRIPTION
Sisimai::Bite::Email::Bigfoot parses a bounce email which created by C<Bigfoot>.
Methods in the module are called from only Sisimai::Message.
=head1 CLASS METHODS
=head2 C<B<description()>>
C<description()> returns description string of this module.
print Sisimai::Bite::Email::Bigfoot->description;
=head2 C<B<smtpagent()>>
C<smtpagent()> returns MTA name.
print Sisimai::Bite::Email::Bigfoot->smtpagent;
=head2 C<B<scan(I<header data>, I<reference to body string>)>>
C<scan()> method parses a bounced email and return results as a array reference.
See Sisimai::Message for more details.
=head1 AUTHOR
azumakuniyuki
=head1 COPYRIGHT
Copyright (C) 2014-2018 azumakuniyuki, All rights reserved.
=head1 LICENSE
This software is distributed under The BSD 2-Clause License.
=cut