Go sisimai compatibility 7e8b

lib/Sisimai/Fact.pm

@@ -14,6 +14,7 @@ use Sisimai::SMTP::Command;
 use Sisimai::SMTP::Failure;
 use Sisimai::String;
 use Sisimai::Rhost;
+use Sisimai::LDA;
 use Class::Accessor::Lite ('new' => 0, 'rw' => [
     'action',           # [String] The value of Action: header
     'addresser',        # [Sisimai::Address] From address
@@ -156,11 +157,19 @@ sub rise {
             my $recv = $mesg1->{'header'}->{'received'} || [];
             unless( $piece->{'rhost'} ) {
                 # Try to pick a remote hostname from Received: headers of the bounce message
-                for my $re ( reverse @$recv ) {
-                    # Check the Received: headers backwards and get a remote hostname
-                    my $cv = Sisimai::RFC5322->received($re)->[0];
-                    next unless Sisimai::RFC1123->is_validhostname($cv);
-                    $piece->{'rhost'} = $cv; last;
+                my $ir = Sisimai::RFC1123->find($e->{'diagnosis'});
+                $piece->{'rhost'} = $ir if Sisimai::RFC1123->is_internethost($ir);
+
+                unless( $piece->{'rhost'} ) {
+                    # The remote hostname in the error message did not exist or is not a valid
+                    # internet hostname
+                    for my $re ( reverse @$recv ) {
+                        # Check the Received: headers backwards and get a remote hostname
+                        last if $piece->{'rhost'};
+                        my $cv = Sisimai::RFC5322->received($re)->[0];
+                        next unless Sisimai::RFC1123->is_internethost($cv);
+                        $piece->{'rhost'} = $cv;
+                    }
                 }
             }
             $piece->{'lhost'} = '' if $piece->{'lhost'} eq $piece->{'rhost'};
@@ -170,7 +179,7 @@ sub rise {
                 for my $le ( @$recv ) {
                     # Check the Received: headers forwards and get a local hostname
                     my $cv = Sisimai::RFC5322->received($le)->[0];
-                    next unless Sisimai::RFC1123->is_validhostname($cv);
+                    next unless Sisimai::RFC1123->is_internethost($cv);
                     $piece->{'lhost'} = $cv; last;
                 }
             }
@@ -308,7 +317,7 @@ sub rise {
             my $ar = Sisimai::Address->new({'address' => $piece->{'recipient'}}) || next RISEOF;
             my @ea = (qw|
                 action deliverystatus diagnosticcode diagnostictype feedbacktype lhost listid
-                messageid origin reason replycode rhost smtpagent smtpcommand subject 
+                messageid origin reason replycode rhost smtpagent smtpcommand subject
             |);
 
             $thing = {
@@ -356,7 +365,11 @@ sub rise {
             if( $thing->{'reason'} eq '' || exists $retryindex->{ $thing->{'reason'} } ) {
                 # The value of "reason" is empty or is needed to check with other values again
                 my $re = $thing->{'reason'} || 'undefined';
-                $thing->{'reason'} = Sisimai::Rhost->find($thing) || Sisimai::Reason->find($thing) || $re;
+                my $cr = "Sisimai::Reason";
+                my $or = Sisimai::LDA->find($thing);    if( $cr->is_explicit($or) ){ $thing->{'reason'} = $or; last }
+                   $or = Sisimai::Rhost->find($thing);  if( $cr->is_explicit($or) ){ $thing->{'reason'} = $or; last }
+                   $or = Sisimai::Reason->find($thing); if( $cr->is_explicit($or) ){ $thing->{'reason'} = $or; last }
+                $thing->{'reason'} = $thing->{'diagnosticcode'} ? "onhold" : $re;
             }
         }
 
@@ -406,8 +419,10 @@ sub rise {
                     $thing->{'action'} = $ox->[2];
                 }
             }
-            $thing->{'action'}   = 'delayed' if $thing->{'reason'} eq 'expired';
-            $thing->{'action'} ||= 'failed'  if $cx->[0] eq '4' || $cx->[0] eq '5';
+            $thing->{'action'}   = 'delivered' if $thing->{'reason'} eq 'delivered';
+            $thing->{'action'} ||= 'delayed'   if $thing->{'reason'} eq 'expired';
+            $thing->{'action'} ||= 'failed'    if $cx->[0] eq '4' || $cx->[0] eq '5';
+            $thing->{'action'} ||= "";
         }
 
         push @$listoffact, bless($thing, __PACKAGE__);

lib/Sisimai/LDA.pm

@@ -0,0 +1,135 @@
+package Sisimai::LDA;
+use v5.26;
+use strict;
+use warnings;
+
+state $LocalAgent = {
+    # Each error message should be a lower-cased string
+    # dovecot/src/deliver/deliver.c
+    # 11: #define DEFAULT_MAIL_REJECTION_HUMAN_REASON \
+    # 12: "Your message to <%t> was automatically rejected:%n%r"
+    "dovecot"    => ["Your message to ", " was automatically rejected:"],
+    "mail.local" => ["mail.local: "],
+    "procmail"   => ["procmail: ", "/procmail "],
+    "maildrop"   => ["maildrop: "],
+    "vpopmail"   => ["vdelivermail: "],
+    "vmailmgr"   => ["vdeliver: "],
+};
+
+state $MessagesOf = {
+    # Each error message should be a lower-cased string
+    "dovecot" => {
+        # dovecot/src/deliver/mail-send.c:94
+        "mailboxfull" => [
+            "not enough disk space",
+            "quota exceeded",   # Dovecot 1.2 dovecot/src/plugins/quota/quota.c
+            "quota exceeded (mailbox for user is full)",    # dovecot/src/plugins/quota/quota.c
+        ],
+        "userunknown" => ["mailbox doesn't exist: "],
+    },
+    "mail.local" => {
+        "mailboxfull" => ["disc quota exceeded", "mailbox full or quota exceeded"],
+        "systemerror" => ["temporary file write error"],
+        "userunknown" => [
+            ": invalid mailbox path",
+            ": unknown user:",
+            ": user missing home directory",
+            ": user unknown",
+        ],
+    },
+    "procmail" => {
+        "mailboxfull" => ["quota exceeded while writing", "user over quota"],
+        "systemerror" => ["service unavailable"],
+        "systemfull"  => ["no space left to finish writing"],
+    },
+    "maildrop" => {
+        "mailboxfull" => ["maildir over quota."],
+        "userunknown" => ["invalid user specified.", "cannot find system user"],
+    },
+    "vpopmail" => {
+        "filtered"    => ["user does not exist, but will deliver to "],
+        "mailboxfull" => ["domain is over quota", "user is over quota"],
+        "suspend"     => ["account is locked email bounced"],
+        "userunknown" => ["sorry, no mailbox here by that name."],
+    },
+    "vmailmgr" => {
+        "mailboxfull" => ["delivery failed due to system quota violation"],
+        "userunknown" => [
+            "invalid or unknown base user or domain",
+            "invalid or unknown virtual user",
+            "user name does not refer to a virtual user"
+        ],
+    },
+};
+
+sub find {
+    # Decode the message body and return a bounce reason detected by the error message of LDA
+    # @param    [Sisimai::Fact] argvs   Decoded email object
+    # @return   [String]                The value of bounce reason
+    my $class = shift;
+    my $argvs = shift // return undef;
+
+    return "" unless length $argvs->{"diagnosticcode"};
+    return "" unless $argvs->{"smtpcommand"} eq "" || $argvs->{"smtpcommand"} eq "DATA";
+
+    my $deliversby = "";    # [String] Local Delivery Agent name
+    my $reasontext = "";    # [String] Detected bounce reason
+    my $issuedcode = lc $argvs->{"diagnosticcode"};
+
+    for my $e ( keys %$LocalAgent ) {
+        # Find a local delivery agent name from the lower-cased error message
+        next unless grep { index($issuedcode, $_) > -1 } $LocalAgent->{ $e }->@*;
+        $deliversby = $e; last;
+    }
+    return "" unless $deliversby;
+
+    for my $e ( keys $MessagesOf->{ $deliversby }->%* ) {
+        # The key nane is a bounce reason name
+        next unless grep { index($issuedcode, $_) > -1 } $MessagesOf->{ $deliversby }->{ $e }->@*;
+        $reasontext = $e; last;
+    }
+
+    $reasontext ||= "mailererror"; # procmail: Couldn't create "/var/mail/tmp.nekochan.22"
+    return $reasontext;
+}
+
+1;
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+Sisimai::LDA - Error message decoder for LDA; Local Delivery Agent
+
+=head1 SYNOPSIS
+
+    use Sisimai::LDA;
+    my $fact = Sisimai::Fact->rise($v);
+    my $ldav = Sisimai::LDA->find($fact->[0]); # Returns the bounce reason LDA generated
+
+=head1 DESCRIPTION
+
+C<Sisimai::LDA> decodes bounced email which created by some LDA, such as Dovecot, C<mail.local>,
+C<procmail>, and so on. This class is called from C<Sisimai::Fact> only.
+
+=head1 CLASS METHODS
+
+=head2 C<B<find(I<Sisimai::Fact Object>)>>
+
+C<find()> method detects the bounce reason using the error message generated by LDA
+
+=head1 AUTHOR
+
+azumakuniyuki
+
+=head1 COPYRIGHT
+
+Copyright (C) 2014-2016,2018-2024 azumakuniyuki, All rights reserved.
+
+=head1 LICENSE
+
+This software is distributed under The BSD 2-Clause License.
+
+=cut
+

lib/Sisimai/Lhost.pm

@@ -22,7 +22,6 @@ sub DELIVERYSTATUS {
         'replycode',   => '',   # SMTP Reply Code
         'diagnosis'    => '',   # The value of Diagnostic-Code header
         'recipient'    => '',   # The value of Final-Recipient header
-        'hardbounce'   => '',   # Hard bounce or not
         'feedbacktype' => '',   # Feedback Type
     };
 }
@@ -41,11 +40,10 @@ sub index {
     # Alphabetical sorted MTA module list
     # @return   [Array] MTA list with order
     return [qw|
-        Activehunter Amavis AmazonSES AmazonWorkMail Aol ApacheJames Barracuda Bigfoot Biglobe Courier
-        Domino DragonFly EZweb EinsUndEins Exchange2003 Exchange2007 Exim FML Facebook GMX GSuite GoogleGroups
-        Gmail IMailServer InterScanMSS KDDI MXLogic MailFoundry MailMarshalSMTP MailRu McAfee MessageLabs
-        MessagingServer Notes Office365 OpenSMTPD Outlook Postfix PowerMTA ReceivingSES SendGrid Sendmail
-        SurfControl V5sendmail Verizon X1 X2 X3 X4 X5 X6 Yahoo Yandex Zoho mFILTER qmail
+        Activehunter AmazonSES ApacheJames Biglobe Courier Domino DragonFly EZweb
+        EinsUndEins Exchange2003 Exchange2007 Exim FML GMX GoogleGroups GoogleWorkspace Gmail
+        IMailServer InterScanMSS KDDI MailFoundry MailMarshalSMTP MessagingServer Notes
+        OpenSMTPD Postfix Sendmail V5sendmail Verizon X1 X2 X3 X6 Zoho mFILTER qmail
     |];
 }