From b733d728c0c24d2a537ae426aa2b6bc8bf915de1 Mon Sep 17 00:00:00 2001 From: azumakuniyuki Date: Sun, 16 Jun 2024 12:13:13 +0900 Subject: [PATCH 1/4] POD and comments improvement (2024-06) --- lib/Sisimai.pm | 12 +- lib/Sisimai/ARF.pm | 22 +- lib/Sisimai/Address.pm | 28 +-- lib/Sisimai/DateTime.pm | 6 +- lib/Sisimai/Fact.pm | 167 +++++++-------- lib/Sisimai/Fact/JSON.pm | 8 +- lib/Sisimai/Fact/YAML.pm | 6 +- lib/Sisimai/Lhost.pm | 11 +- lib/Sisimai/Lhost/Activehunter.pm | 15 +- lib/Sisimai/Lhost/Amavis.pm | 12 +- lib/Sisimai/Lhost/AmazonSES.pm | 11 +- lib/Sisimai/Lhost/AmazonWorkMail.pm | 12 +- lib/Sisimai/Lhost/Aol.pm | 13 +- lib/Sisimai/Lhost/ApacheJames.pm | 16 +- lib/Sisimai/Lhost/Barracuda.pm | 12 +- lib/Sisimai/Lhost/Bigfoot.pm | 12 +- lib/Sisimai/Lhost/Biglobe.pm | 12 +- lib/Sisimai/Lhost/Courier.pm | 13 +- lib/Sisimai/Lhost/Domino.pm | 17 +- lib/Sisimai/Lhost/DragonFly.pm | 12 +- lib/Sisimai/Lhost/EZweb.pm | 14 +- lib/Sisimai/Lhost/EinsUndEins.pm | 12 +- lib/Sisimai/Lhost/Exchange2003.pm | 16 +- lib/Sisimai/Lhost/Exchange2007.pm | 16 +- lib/Sisimai/Lhost/Exim.pm | 13 +- lib/Sisimai/Lhost/FML.pm | 14 +- lib/Sisimai/Lhost/Facebook.pm | 13 +- lib/Sisimai/Lhost/GMX.pm | 14 +- lib/Sisimai/Lhost/GSuite.pm | 14 +- lib/Sisimai/Lhost/Gmail.pm | 14 +- lib/Sisimai/Lhost/GoogleGroups.pm | 12 +- lib/Sisimai/Lhost/IMailServer.pm | 15 +- lib/Sisimai/Lhost/InterScanMSS.pm | 16 +- lib/Sisimai/Lhost/KDDI.pm | 13 +- lib/Sisimai/Lhost/MXLogic.pm | 13 +- lib/Sisimai/Lhost/MailFoundry.pm | 14 +- lib/Sisimai/Lhost/MailMarshalSMTP.pm | 17 +- lib/Sisimai/Lhost/MailRu.pm | 13 +- lib/Sisimai/Lhost/McAfee.pm | 12 +- lib/Sisimai/Lhost/MessageLabs.pm | 17 +- lib/Sisimai/Lhost/MessagingServer.pm | 17 +- lib/Sisimai/Lhost/Notes.pm | 14 +- lib/Sisimai/Lhost/Office365.pm | 14 +- lib/Sisimai/Lhost/OpenSMTPD.pm | 15 +- lib/Sisimai/Lhost/Outlook.pm | 12 +- lib/Sisimai/Lhost/Postfix.pm | 14 +- lib/Sisimai/Lhost/PowerMTA.pm | 14 +- lib/Sisimai/Lhost/ReceivingSES.pm | 14 +- lib/Sisimai/Lhost/SendGrid.pm | 15 +- lib/Sisimai/Lhost/Sendmail.pm | 16 +- lib/Sisimai/Lhost/SurfControl.pm | 14 +- lib/Sisimai/Lhost/V5sendmail.pm | 13 +- lib/Sisimai/Lhost/Verizon.pm | 14 +- lib/Sisimai/Lhost/X1.pm | 12 +- lib/Sisimai/Lhost/X2.pm | 12 +- lib/Sisimai/Lhost/X3.pm | 13 +- lib/Sisimai/Lhost/X4.pm | 12 +- lib/Sisimai/Lhost/X5.pm | 12 +- lib/Sisimai/Lhost/X6.pm | 12 +- lib/Sisimai/Lhost/Yahoo.pm | 14 +- lib/Sisimai/Lhost/Yandex.pm | 15 +- lib/Sisimai/Lhost/Zoho.pm | 14 +- lib/Sisimai/Lhost/mFILTER.pm | 12 +- lib/Sisimai/Lhost/qmail.pm | 15 +- lib/Sisimai/MDA.pm | 7 +- lib/Sisimai/Mail.pm | 19 +- lib/Sisimai/Mail/Maildir.pm | 21 +- lib/Sisimai/Mail/Mbox.pm | 23 ++- lib/Sisimai/Mail/Memory.pm | 19 +- lib/Sisimai/Mail/STDIN.pm | 18 +- lib/Sisimai/Message.pm | 59 ++---- lib/Sisimai/Order.pm | 17 +- lib/Sisimai/RFC1894.pm | 12 +- lib/Sisimai/RFC2045.pm | 30 +-- lib/Sisimai/RFC3464.pm | 13 +- lib/Sisimai/RFC3834.pm | 10 +- lib/Sisimai/RFC5322.pm | 9 +- lib/Sisimai/RFC5965.pm | 2 +- lib/Sisimai/Reason.pm | 282 +------------------------- lib/Sisimai/Reason/AuthFailure.pm | 12 +- lib/Sisimai/Reason/BadReputation.pm | 12 +- lib/Sisimai/Reason/Blocked.pm | 15 +- lib/Sisimai/Reason/ContentError.pm | 20 +- lib/Sisimai/Reason/Delivered.pm | 15 +- lib/Sisimai/Reason/ExceedLimit.pm | 17 +- lib/Sisimai/Reason/Expired.pm | 16 +- lib/Sisimai/Reason/Feedback.pm | 10 +- lib/Sisimai/Reason/Filtered.pm | 22 +- lib/Sisimai/Reason/HasMoved.pm | 18 +- lib/Sisimai/Reason/HostUnknown.pm | 21 +- lib/Sisimai/Reason/MailboxFull.pm | 16 +- lib/Sisimai/Reason/MailerError.pm | 15 +- lib/Sisimai/Reason/MesgTooBig.pm | 19 +- lib/Sisimai/Reason/NetworkError.pm | 14 +- lib/Sisimai/Reason/NoRelaying.pm | 15 +- lib/Sisimai/Reason/NotAccept.pm | 21 +- lib/Sisimai/Reason/NotCompliantRFC.pm | 14 +- lib/Sisimai/Reason/OnHold.pm | 15 +- lib/Sisimai/Reason/PolicyViolation.pm | 18 +- lib/Sisimai/Reason/Rejected.pm | 20 +- lib/Sisimai/Reason/RequirePTR.pm | 18 +- lib/Sisimai/Reason/SecurityError.pm | 21 +- lib/Sisimai/Reason/SpamDetected.pm | 14 +- lib/Sisimai/Reason/Speeding.pm | 14 +- lib/Sisimai/Reason/Suspend.pm | 14 +- lib/Sisimai/Reason/SyntaxError.pm | 19 +- lib/Sisimai/Reason/SystemError.pm | 14 +- lib/Sisimai/Reason/SystemFull.pm | 18 +- lib/Sisimai/Reason/TooManyConn.pm | 17 +- lib/Sisimai/Reason/Undefined.pm | 11 +- lib/Sisimai/Reason/UserUnknown.pm | 23 ++- lib/Sisimai/Reason/Vacation.pm | 12 +- lib/Sisimai/Reason/VirusDetected.pm | 17 +- lib/Sisimai/Rhost.pm | 10 +- lib/Sisimai/Rhost/Apple.pm | 10 +- lib/Sisimai/Rhost/Cox.pm | 10 +- lib/Sisimai/Rhost/FrancePTT.pm | 10 +- lib/Sisimai/Rhost/GoDaddy.pm | 10 +- lib/Sisimai/Rhost/Google.pm | 11 +- lib/Sisimai/Rhost/IUA.pm | 10 +- lib/Sisimai/Rhost/KDDI.pm | 10 +- lib/Sisimai/Rhost/Microsoft.pm | 10 +- lib/Sisimai/Rhost/Mimecast.pm | 10 +- lib/Sisimai/Rhost/NTTDOCOMO.pm | 10 +- lib/Sisimai/Rhost/Spectrum.pm | 10 +- lib/Sisimai/Rhost/Tencent.pm | 12 +- lib/Sisimai/Rhost/YahooInc.pm | 10 +- lib/Sisimai/SMTP.pm | 2 +- lib/Sisimai/SMTP/Command.pm | 6 +- lib/Sisimai/SMTP/Error.pm | 10 +- lib/Sisimai/SMTP/Reply.pm | 7 +- lib/Sisimai/SMTP/Status.pm | 16 +- lib/Sisimai/SMTP/Transcript.pm | 4 +- lib/Sisimai/String.pm | 20 +- lib/Sisimai/Time.pm | 4 +- 135 files changed, 1040 insertions(+), 1298 deletions(-) diff --git a/lib/Sisimai.pm b/lib/Sisimai.pm index c2087177..43d51b6d 100644 --- a/lib/Sisimai.pm +++ b/lib/Sisimai.pm @@ -164,16 +164,16 @@ Sisimai - Mail Analyzing Interface for bounce mails. =head1 DESCRIPTION -C is a library that decodes complex and diverse bounce emails and outputs the results of -the delivery failure, such as the reason for the bounce and the recipient email address, in -structured data. It is also possible to output in JSON format. +B is a library that decodes complex and diverse bounce emails and outputs the results of +the delivery failure, such as the reason for the bounce and the recipient email address, in structured +data. It is also possible to output in JSON format. =head1 BASIC USAGE =head2 C)>> C method provides the feature for getting decoded data as Perl Hash reference from bounced -email messages as the following. Beginning with v4.25.6, new accessor origin which keeps the path +email messages as the following. Beginning with v4.25.6, new accessor C which keeps the path to email file as a data source is available. use Sisimai; @@ -243,8 +243,8 @@ C method like following command: =head2 Callback Feature -C (c and three _s, looks like a fishhook) argument of Sisimai->rise and Cdump()> is -an array reference and is a parameter to receive code references for callback feature. The first +C (C and three C<_>s, looks like a fishhook) argument of Sisimai->rise and Cdump()> +is an array reference and is a parameter to receive code references for callback feature. The first element of C argument is called at Csift()> for dealing email headers and entire message body. The second element of C argument is called at the end of each email file processing. The result generated by the callback method is accessible via Ccatch>. diff --git a/lib/Sisimai/ARF.pm b/lib/Sisimai/ARF.pm index 0e46295b..61ea39d1 100644 --- a/lib/Sisimai/ARF.pm +++ b/lib/Sisimai/ARF.pm @@ -344,36 +344,32 @@ __END__ =head1 NAME -Sisimai::ARF - Parser class for detecting ARF: Abuse Feedback Reporting Format. +C - Parser class for detecting ARF: Abuse Feedback Reporting Format. =head1 SYNOPSIS -Do not use this class directly, use Sisimai::ARF. - use Sisimai::ARF; my $v = Sisimai::ARF->inquire($header, $body); =head1 DESCRIPTION -Sisimai::ARF is a parser for email returned as a Feedback Loop report message. +C is a parser for email returned as a Feedback Loop report message. =head1 FEEDBACK TYPES -=head2 B - -Unsolicited email or some other kind of email abuse. +=over -=head2 B +=item B spam or some other kind of email abuse -Indicates some kind of C or C activity. +=item B Indicates some kind of fraud or phishing activity -=head2 B +=item B report of a virus found in the originating message -Any other feedback that does not fit into other registered types. +=item B any other feedback that doesn't fit into other types -=head2 B +=item B can be used to report an email message that was mistakenly marked as spam -Report of a virus found in the originating message. +=back =head1 SEE ALSO diff --git a/lib/Sisimai/Address.pm b/lib/Sisimai/Address.pm index 4ad010ef..753fc9ac 100644 --- a/lib/Sisimai/Address.pm +++ b/lib/Sisimai/Address.pm @@ -475,13 +475,13 @@ Sisimai::Address - Email address object =head1 DESCRIPTION -Sisimai::Address provide methods for dealing email address. +C provide methods for dealing email address. =head1 CLASS METHODS =head2 C)>> -C checks the argument is valid email address or not. +C method checks the argument is valid email address or not. print Sisimai::Address->is_emailaddress('neko@example.jp'); # 1 print Sisimai::Address->is_emailaddress('neko%example.jp'); # 0 @@ -496,14 +496,14 @@ C checks the argument is valid email address or not. =head2 C)>> -C checks the argument is mailer-daemon or not. +C method checks the argument is B or not. print Sisimai::Address->is_mailerdaemon('neko@example.jp'); # 0 print Sisimai::Address->is_mailerdaemon('mailer-daemon@example.jp'); # 1 =head2 C)>> -C is a new parser for getting only email address from text including email addresses. +C method is a new parser for getting only email address from text including email addresses. my $r = 'Stray cat , nyaa@example.org (White Cat)', my $v = Sisimai::Address->find($r); @@ -524,7 +524,7 @@ C is a new parser for getting only email address from text including ema =head2 C)>> -C works Ruleset 3, and 4 of sendmail.cf. +C method works Ruleset 3, and 4 of F. my $r = [ 'Stray cat ', @@ -538,14 +538,14 @@ C works Ruleset 3, and 4 of sendmail.cf. =head2 C)>> -C gets the original email address from VERP +C method gets the original email address from C my $r = 'nyaa+neko=example.org@example.org'; print Sisimai::Address->expand_verp($r); # neko@example.org =head2 C)>> -C gets the original email address from alias +C method gets the original email address from the alias address my $r = 'nyaa+neko@example.org'; print Sisimai::Address->expand_alias($r); # nyaa@example.org @@ -554,28 +554,28 @@ C gets the original email address from alias =head2 C> -C returns a local part of the email address. +C method returns a local part of the email address. my $v = Sisimai::Address->new({ 'address' => 'neko@example.org' }); print $v->user; # neko =head2 C> -C returns a domain part of the email address. +C method returns a domain part of the email address. my $v = Sisimai::Address->new({ 'address' => 'neko@example.org' }); print $v->host; # example.org =head2 C> -C returns an email address +C method returns an email address my $v = Sisimai::Address->new({ 'address' => 'neko@example.org' }); print $v->address; # neko@example.org =head2 C> -C returns a VERP email address +C method returns a VERP email address my $v = Sisimai::Address->new({ 'address' => 'neko+nyaan=example.org@example.org' }); print $v->verp; # neko+nyaan=example.org@example.org @@ -583,7 +583,7 @@ C returns a VERP email address =head2 C> -C returns an email address (alias) +C method returns an email address (alias) my $v = Sisimai::Address->new({ 'address' => 'neko+nyaan@example.org' }); print $v->alias; # neko+nyaan@example.org @@ -591,7 +591,7 @@ C returns an email address (alias) =head2 C> -C returns a display name +C method returns a display name my $e = '"Neko, Nyaan" '; my $r = Sisimai::Address->find($e); @@ -601,7 +601,7 @@ C returns a display name =head2 C> -C returns a comment +C method returns a comment my $e = '"Neko, Nyaan" '; my $v = Sisimai::Address->new(shift Sisimai::Address->find($e)->@*); diff --git a/lib/Sisimai/DateTime.pm b/lib/Sisimai/DateTime.pm index 656605c7..cc6ca8c4 100644 --- a/lib/Sisimai/DateTime.pm +++ b/lib/Sisimai/DateTime.pm @@ -414,13 +414,13 @@ Sisimai::DateTime - Date and time utilities =head1 DESCRIPTION -Sisimai::DateTime provide methods for dealing date and time. +C provide methods for dealing date and time. =head1 CLASS METHODS =head2 C)>> -C convert various date format string. +C method converts a various date format string. my $x = 'Fri, 9 Apr 2004 04:01:03 +0000 (GMT)'; my $y = '27 Apr 2009 08:08:54 +0900'; @@ -429,7 +429,7 @@ C convert various date format string. =head2 C)>> -C convert a time zone abbreviation to 4 digit string of time zone. +C method converts a time zone abbreviation to 4 digit string of time zone. print Sisimai::DateTime->abbr2tz('JST'); # +0900 print Sisimai::DateTime->abbr2tz('UTC'); # +0000 diff --git a/lib/Sisimai/Fact.pm b/lib/Sisimai/Fact.pm index 5fa0a0cf..3d8153b8 100644 --- a/lib/Sisimai/Fact.pm +++ b/lib/Sisimai/Fact.pm @@ -472,13 +472,14 @@ Sisimai::Fact - Parsed data object =head1 DESCRIPTION -Sisimai::Fact generate parsed data from Sisimai::Message object. +C generates a decoded bounce email data structure from C object. =head1 CLASS METHODS =head2 C)>> -C generate parsed data and returns an array reference which are including Sisimai::Fact objects. +C method generate decoded data and returns an array reference which are including +C objects. my $mail = Sisimai::Mail->new('/var/mail/root'); while( my $r = $mail->read ) { @@ -490,34 +491,16 @@ C generate parsed data and returns an array reference which are including } } -If you want to get bounce records which reason is "delivered", set "delivered" option to rise() method -like the following: +If you want to get bounce records which reason is C<"delivered">, set C option to C +method like the following: my $fact = Sisimai::Fact->rise('data' => $r, 'delivered' => 1); -Beginning from v4.19.0, `hook` argument is available to callback user defined method like the following -codes: - - my $call = sub { - my $argv = shift; - my $fish = { 'x-mailer' => '' }; - - if( $argv->{'message'} =~ /^X-Mailer:\s*(.+)$/m ) { - $fish->{'x-mailer'} = $1; - } - - return $fish; - }; - my $fact = Sisimai::Fact->rise('data' => 'entire-email-text'); - for my $e ( @$fact ) { - print $e->catch->{'x-mailer'}; # Apple Mail (2.1283) - } - =head1 INSTANCE METHODS =head2 C> -C convert the object to a hash reference. +C method converts the object to a hash reference. my $hash = $self->damn; print $hash->{'recipient'}; # user@example.jp @@ -525,31 +508,31 @@ C convert the object to a hash reference. =head1 PROPERTIES -Sisimai::Fact have the following properties: +C have the following properties: =head2 C (I) -C is the value of Action: field in a bounce email message such as C or C. +C is the value of C field in a bounce email message such as C or C. Action: failed =head2 C (I -C is L object generated from the sender address. When Sisimai::Fact -object is dumped as JSON, this value converted to an email address. Sisimai::Address object have +C is L object generated from the sender address. When C +object is dumped as JSON, this value converted to an email address. C object have the following accessors: =over -=item - user() - the local part of the address +=item - C - the local part of the address -=item - host() - the domain part of the address +=item - C - the domain part of the address -=item - address() - email address +=item - C - email address -=item - verp() - variable envelope return path +=item - C - variable envelope return path -=item - alias() - alias of the address +=item - C - alias of the address =back @@ -557,7 +540,7 @@ the following accessors: =head2 C (I) -C is an alias address of the recipient. When the Original-Recipient: field or +C is an alias address of the recipient. When the C field or C string did not exist in a bounce message, this value is empty. Original-Recipient: rfc822;kijitora@example.org @@ -567,89 +550,104 @@ C string did not exist in a bounce message, this value =head2 C (I) -C is the value of Status: field in a bounce message. When the message has no Status: -field, Sisimai set pseudo value like 5.0.9XX to this value. The range of values only C<4.x.x> or C<5.x.x>. +C is the value of C field in a bounce message. When the message has no +C field, Sisimai set pseudo value like C<5.0.9XX> to this value. The range of values only +C<4.x.x> or C<5.x.x>. Status: 5.0.0 (permanent failure) =head2 C (I) C is the domain part of the recipient address. This value is the same as the return -value from host() method of C accessor. +value from C method of C accessor. =head2 C (I) -C is an error message picked from Diagnostic-Code: field or message body in a bounce -message. This value and the value of C, C, C, C, +C is an error message picked from C field or message body in a +bounce message. This value and the value of C, C, C, C, and C will be referred by L to decide the bounce reason. Diagnostic-Code: SMTP; 554 5.4.6 Too many hops =head2 C (C) -C is a type like C or C picked from Diagnostic-Code: field in a bounce -message. When there is no Diagnostic-Code: field in the bounce message, this value will be empty. +C is a type like C or C picked from C field in a +bounce message. When there is no C field in the bounce message, this value will +be empty. Diagnostic-Code: X-Unix; 255 =head2 C (I) -C is the value of Feedback-Type: field like C, C, C in a bounce -message. When the message is not ARF format or the value of C is not C, this value -will be empty. +C is the value of C field like C, C, C in a +bounce message. When the message is not ARF format or the value of C is not C, +this value will be empty. Content-Type: message/feedback-report Feedback-Type: abuse User-Agent: SMP-FBL +=head2 C (I) + +The value of C indicates whether the reason of the bounce is a hard bounce or not. This +accessor has added in Sisimai 5.0.0. The range of the values are the followings: + +=over + +=item C<1> = Hard bounce + +=item C<0> = Not a hard bounce + +=back + =head2 C (I) C is a local MTA name to be used as a gateway for sending email message or the value of -Reporting-MTA field in a bounce message. When there is no Reporting-MTA field in the bounce message, -Sisimai try to get the value from Received header. +C field in a bounce message. When there is no C field in a bounce +message, Sisimai try to get the value from C headers. Reporting-MTA: dns; mx4.smtp.example.co.jp =head2 C (I) -C is the value of List-Id header of the original message. When there is no List-Id field in -the original message or the bounce message did not include the original message, this value will be -empty. +C is the value of C header of the original message. When there is no C +field in the original message or the bounce message did not include the original message, this value +will be empty. List-Id: Mailman mailing list management users =head2 C (I) -C is the value of Message-Id header of the original message. When the original message did -not include Message-Id: header or the bounce message did not include the original message, this value -will be empty. +C is the value of C header of the original message. When the original message +did not include C header or the bounce message did not include the original message, +this value will be empty. Message-Id: <201310160515.r9G5FZh9018575@smtpgw.example.jp> =head2 C (I) -C is the path to the original email file of the parsed results. When the original email data +C is the path to the original email file of the decoded results. When the original email data were input from STDIN, the value is C<>, were input from a variable, the value is C<>. This accessor method has been implemented at v4.25.6. =head2 C (I -C is L object generated from the recipient address. When Sisimai::Fact -object is dumped as JSON, this value converted to an email address. Sisimai::Address object have the -following accessors: +C is L object generated from the recipient address. When C +object is dumped as JSON, this value converted to an email address. C object have +the following accessors: =over -=item - user() - the local part of the address +=item - C - the local part of the address -=item - host() - the domain part of the address +=item - C - the domain part of the address -=item - address() - email address +=item - C - email address -=item - verp() - variable envelope return path +=item - C - variable envelope return path -=item - alias() - alias of the address +=item - C - alias of the address =back @@ -659,13 +657,13 @@ following accessors: =head2 C (I) C is the value of bounce reason Sisimai detected. When this value is C or C, -it means that Sisimai could not decide the reason. All the reasons Sisismai can detect are available +it means that Sisimai could not decide the reason. All the reasons Sisimai can detect are available at L or web site L. =head2 C (I) -C is the value of SMTP reply code picked from the error message or the value of Diagnostic-Code: -field in a bounce message. The range of values is only 4xx or 5xx. +C is the value of SMTP reply code picked from the error message or the value of C +field in a bounce message. The range of values is only C<4xx> or C<5xx>. ----- The following addresses had permanent fatal errors ----- @@ -673,16 +671,16 @@ field in a bounce message. The range of values is only 4xx or 5xx. =head2 C (I) -C is a remote MTA name which has rejected the message you sent or the value of Remote-MTA: -field in a bounce message. When there is no Remote-MTA field in the bounce message, Sisimai try to -get the value from Received header. +C is a remote MTA name which has rejected the message you sent or the value of C +field in a bounce message. When there is no C field in the bounce message, Sisimai try +to get the value from C headers. Remote-MTA: DNS; g5.example.net =head2 C (I) C is the domain part of the sender address. This value is the same as the return value -from host() method of addresser accessor. +from C method of addresser accessor. =head2 C (I) @@ -692,39 +690,26 @@ status information from a bounce message. =head2 C (I) -C is a SMTP command name picked from the error message or the value of Diagnostic-Code: +C is a SMTP command name picked from the error message or the value of C field in a bounce message. When there is no SMTP command in the bounce message, this value will be -empty. The list of values is C, C, C, C, and C. +empty. The list of values is C, C, C, C, C, and C. : host mx1.example.go.jp[192.0.2.127] said: 550 5.1.6 recipient no longer on server: kijitora@example.go.jp (in reply to RCPT TO command) -=head2 C (I) - -The value of C indicates whether the reason of the bounce is a hard bounce or not. This -accessor has added in Sisimai 5.0.0. The range of the values are the followings: - -=over - -=item 1 = Hard bounce - -=item 0 = Not a hard bounce - -=back - =head2 C (I) -C is the value of Subject header of the original message. When the original message which -is included in a bounce email contains no Subject header (removed by remote MTA), this value will be -empty. If the value of Subject header of the original message contain any multibyte character -(non-ASCII character), such as MIME encoded Japanese or German and so on, the value of subject in -parsed data is encoded with UTF-8 again. +C is the value of C header of the original message. When the original message which +is included in a bounce email contains no C header (removed by remote MTA), this value will +be empty. If the value of C header of the original message contain any multibyte character +(non-ASCII character), such as MIME encoded Japanese or German and so on, the value of C<"subject"> +in decoded data is encoded with UTF-8 again. =head2 C (I) C is an identifier of each email-bounce. The token string is created from the sender email -address (addresser) and the recipient email address (recipient) and the machine time of the date in -a bounce message as an MD5 hash value. The token value is generated at C method of +address (C) and the recipient email address (C) and the machine time of the +date in a bounce message as an MD5 hash value. The token value is generated at C method of L class. If you want to get the same token string at command line, try to run the following command: @@ -734,8 +719,8 @@ If you want to get the same token string at command line, try to run the followi =head2 C (I) -C is the date which email has bounced as a L (Child class of Time::Piece) -object. When Sisimai::Fact object is dumped as JSON, this value will be converted to an UNIX machine +C is the date which email has bounced as a L (Child class of C) +object. When C object is dumped as JSON, this value will be converted to an UNIX machine time (32 bits integer). Arrival-Date: Thu, 29 Apr 2009 23:45:33 +0900 diff --git a/lib/Sisimai/Fact/JSON.pm b/lib/Sisimai/Fact/JSON.pm index 1632be86..8f76cc58 100644 --- a/lib/Sisimai/Fact/JSON.pm +++ b/lib/Sisimai/Fact/JSON.pm @@ -25,7 +25,7 @@ __END__ =head1 NAME -Sisimai::Fact::JSON - Dumps parsed data object as a JSON format +Sisimai::Fact::JSON - Dumps decoded data object as a JSON format =head1 SYNOPSIS @@ -37,14 +37,14 @@ Sisimai::Fact::JSON - Dumps parsed data object as a JSON format =head1 DESCRIPTION -Sisimai::Fact::JSON dumps parsed data object as a JSON format. This class and method should be called -from the parent object "Sisimai::Fact". +C dumps decoded data object as a JSON format. This class and method should be +called only from the parent object C. =head1 CLASS METHODS =head2 C)>> -C method returns Sisimai::Fact object as a JSON formatted string. +C method returns C object as a JSON formatted string. my $mail = Sisimai::Mail->new('/var/mail/root'); while( my $r = $mail->read ) { diff --git a/lib/Sisimai/Fact/YAML.pm b/lib/Sisimai/Fact/YAML.pm index e7f3c904..a4824d4b 100644 --- a/lib/Sisimai/Fact/YAML.pm +++ b/lib/Sisimai/Fact/YAML.pm @@ -70,14 +70,14 @@ Sisimai::Fact::YAML - Dumps parsed data object as a YAML format =head1 DESCRIPTION -Sisimai::Fact::YAML dumps parsed data object as a YAML format. This class and method should be called -from the parent object "Sisimai::Fact". +C dumps decoded data object as a YAML format. This class and method should be +called only from the parent object C. =head1 CLASS METHODS =head2 C)>> -C method returns Sisimai::Fact object as a YAML formatted string. +C method returns C object as a YAML formatted string. my $mail = Sisimai::Mail->new('/var/mail/root'); while( my $r = $mail->read ) { diff --git a/lib/Sisimai/Lhost.pm b/lib/Sisimai/Lhost.pm index 079d9b71..c3e0c4f2 100644 --- a/lib/Sisimai/Lhost.pm +++ b/lib/Sisimai/Lhost.pm @@ -5,7 +5,7 @@ use warnings; use Sisimai::RFC5322; sub DELIVERYSTATUS { - # Data structure for parsed bounce messages + # Data structure for decoded bounce messages # @private # @return [Hash] Data structure for delivery status return { @@ -65,11 +65,11 @@ sub path { } sub inquire { - # Method of a parent class to parse a bounce message of each MTA + # Method of a parent class to decode a bounce message of each MTA # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing return undef; } @@ -84,11 +84,12 @@ Sisimai::Lhost - Base class for Sisimai::Lhost::* =head1 SYNOPSIS -Do not use or require this class directly, use Sisimai::Lhost::*, such as Sisimai::Lhost::Sendmail, instead. +B, call a class of C, such as +C, instead. =head1 DESCRIPTION -Sisimai::Lhost is a base class for all the MTA modules of Sisimai::Lhost::*. +C is a base class for all the MTA modules of C. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Activehunter.pm b/lib/Sisimai/Lhost/Activehunter.pm index 5e98f409..2fc17bf9 100644 --- a/lib/Sisimai/Lhost/Activehunter.pm +++ b/lib/Sisimai/Lhost/Activehunter.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.1 my $class = shift; my $mhead = shift // return undef; @@ -81,7 +81,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Activehunter - bounce mail parser class for Active!hunter. +Sisimai::Lhost::Activehunter - bounce mail decodeder class for Active!hunter L =head1 SYNOPSIS @@ -89,21 +89,22 @@ Sisimai::Lhost::Activehunter - bounce mail parser class for Active!hunter. =head1 DESCRIPTION -Sisimai::Lhost::Activehunter parses a bounce email which created by C. -Methods in the module are called from only Sisimai::Message. +C decodes a bounce email which created by QUALITIA Active!hunter +L. Methods in the module are called from only +C. =head1 CLASS METHODS =head2 C> -C returns description string of this module. +C method returns description string of this module. print Sisimai::Lhost::Activehunter->description; =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Amavis.pm b/lib/Sisimai/Lhost/Amavis.pm index e4ab4fa5..e9d1e370 100644 --- a/lib/Sisimai/Lhost/Amavis.pm +++ b/lib/Sisimai/Lhost/Amavis.pm @@ -11,7 +11,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.25.0 my $class = shift; my $mhead = shift // return undef; @@ -167,7 +167,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Amavis - bounce mail parser class for C. +Sisimai::Lhost::Amavis - bounce mail decoder class for C. =head1 SYNOPSIS @@ -175,8 +175,8 @@ Sisimai::Lhost::Amavis - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Amavis parses a bounce email which created by C. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by C. Methods in the +module are called from only C. =head1 CLASS METHODS @@ -188,8 +188,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/AmazonSES.pm b/lib/Sisimai/Lhost/AmazonSES.pm index d4833ccf..7f0257a8 100644 --- a/lib/Sisimai/Lhost/AmazonSES.pm +++ b/lib/Sisimai/Lhost/AmazonSES.pm @@ -11,7 +11,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.2 my $class = shift; my $mhead = shift // return undef; @@ -322,7 +322,7 @@ __END__ =head1 NAME -Sisimai::Lhost::AmazonSES - bounce mail parser class for C. +Sisimai::Lhost::AmazonSES - bounce mail decoder class for Amazon SES L =head1 SYNOPSIS @@ -330,8 +330,9 @@ Sisimai::Lhost::AmazonSES - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::AmazonSES parses a bounce email or a JSON string which created by -C. Methods in the module are called from only C. +C decodes a bounce email or a JSON string which created by Amazon Simple +Email Service L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -343,7 +344,7 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. +C method decodes a bounced email and return results as a array reference. See C for more details. =head2 C)>> diff --git a/lib/Sisimai/Lhost/AmazonWorkMail.pm b/lib/Sisimai/Lhost/AmazonWorkMail.pm index 9687c933..edc6dd60 100644 --- a/lib/Sisimai/Lhost/AmazonWorkMail.pm +++ b/lib/Sisimai/Lhost/AmazonWorkMail.pm @@ -11,7 +11,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.29 my $class = shift; my $mhead = shift // return undef; @@ -124,7 +124,7 @@ __END__ =head1 NAME -Sisimai::Lhost::AmazonWorkMail - bounce mail parser class for C. +Sisimai::Lhost::AmazonWorkMail - bounce mail decoder class for Amazon WorkMail L. =head1 SYNOPSIS @@ -132,8 +132,8 @@ Sisimai::Lhost::AmazonWorkMail - bounce mail parser class for C =head1 DESCRIPTION -Sisimai::Lhost::AmazonWorkMail parses a bounce email which created by C. Methods in -the module are called from only Sisimai::Message. +C decodes a bounce email which created by Amazon WorkMail L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -145,8 +145,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Aol.pm b/lib/Sisimai/Lhost/Aol.pm index 2e20f0bb..f261388f 100644 --- a/lib/Sisimai/Lhost/Aol.pm +++ b/lib/Sisimai/Lhost/Aol.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decoded or the arguments are missing # @since v4.1.3 my $class = shift; my $mhead = shift // return undef; @@ -127,7 +127,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Aol - bounce mail parser class for C. +Sisimai::Lhost::Aol - bounce mail decoder class for Aol Mail L. =head1 SYNOPSIS @@ -135,8 +135,8 @@ Sisimai::Lhost::Aol - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Aol parses a bounce email which created by C. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by Aol Mail L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -148,8 +148,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -165,4 +165,3 @@ This software is distributed under The BSD 2-Clause License. =cut - diff --git a/lib/Sisimai/Lhost/ApacheJames.pm b/lib/Sisimai/Lhost/ApacheJames.pm index a310d678..4d4ebc90 100644 --- a/lib/Sisimai/Lhost/ApacheJames.pm +++ b/lib/Sisimai/Lhost/ApacheJames.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Java Apache Mail Enterprise Server' } +sub description { 'James: https://james.apache.org/' } sub inquire { - # Detect an error from ApacheJames + # Detect an error from Apache James # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.26 my $class = shift; my $mhead = shift // return undef; @@ -125,7 +125,7 @@ __END__ =head1 NAME -Sisimai::Lhost::ApacheJames - bounce mail parser class for C. +Sisimai::Lhost::ApacheJames - bounce mail decoder class for Apache James L. =head1 SYNOPSIS @@ -133,8 +133,8 @@ Sisimai::Lhost::ApacheJames - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::ApacheJames parses a bounce email which created by C. Methods in the -module are called from only Sisimai::Message. +C decodes a bounce email which created by Apache James L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -146,8 +146,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Barracuda.pm b/lib/Sisimai/Lhost/Barracuda.pm index 138015f1..a051752c 100644 --- a/lib/Sisimai/Lhost/Barracuda.pm +++ b/lib/Sisimai/Lhost/Barracuda.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.25.6 my $class = shift; my $mhead = shift // return undef; @@ -96,7 +96,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Barracuda - bounce mail parser class for C. +Sisimai::Lhost::Barracuda - bounce mail decoder class for Barracuda L. =head1 SYNOPSIS @@ -104,8 +104,8 @@ Sisimai::Lhost::Barracuda - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Barracuda parses a bounce email which created by C. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by Barracuda L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -117,8 +117,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Bigfoot.pm b/lib/Sisimai/Lhost/Bigfoot.pm index 6d712ba4..32f15e34 100644 --- a/lib/Sisimai/Lhost/Bigfoot.pm +++ b/lib/Sisimai/Lhost/Bigfoot.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.10 my $class = shift; my $mhead = shift // return undef; @@ -129,7 +129,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Bigfoot - bounce mail parser class for C. +Sisimai::Lhost::Bigfoot - bounce mail decoder class for Bigfoot L. =head1 SYNOPSIS @@ -137,8 +137,8 @@ Sisimai::Lhost::Bigfoot - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Bigfoot parses a bounce email which created by C. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by Bigfoot L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -150,8 +150,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Biglobe.pm b/lib/Sisimai/Lhost/Biglobe.pm index fb6957b4..01d006a2 100644 --- a/lib/Sisimai/Lhost/Biglobe.pm +++ b/lib/Sisimai/Lhost/Biglobe.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -103,7 +103,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Biglobe - bounce mail parser class for C. +Sisimai::Lhost::Biglobe - bounce mail decoder class for BIGLOBE (L). =head1 SYNOPSIS @@ -111,8 +111,8 @@ Sisimai::Lhost::Biglobe - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Biglobe parses a bounce email which created by C. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by BIGLOBE L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -124,8 +124,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Courier.pm b/lib/Sisimai/Lhost/Courier.pm index c9fef4d0..b7e0be59 100644 --- a/lib/Sisimai/Lhost/Courier.pm +++ b/lib/Sisimai/Lhost/Courier.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -164,7 +164,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Courier - bounce mail parser class for C. +Sisimai::Lhost::Courier - bounce mail decoder class for Courier MTA L. =head1 SYNOPSIS @@ -172,8 +172,8 @@ Sisimai::Lhost::Courier - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Courier parses a bounce email which created by C. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by Courier MTA L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -185,8 +185,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -201,3 +201,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/Domino.pm b/lib/Sisimai/Lhost/Domino.pm index 80ef107b..ce1a9836 100644 --- a/lib/Sisimai/Lhost/Domino.pm +++ b/lib/Sisimai/Lhost/Domino.pm @@ -7,13 +7,13 @@ use Sisimai::String; use Encode; use Encode::Guess; Encode::Guess->add_suspects(Sisimai::String->encodenames->@*); -sub description { 'IBM Domino Server' } +sub description { 'HCL Domino' } sub inquire { - # Detect an error from IBM Domino + # Detect an error from HCL Domino # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.2 my $class = shift; my $mhead = shift // return undef; @@ -170,7 +170,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Domino - bounce mail parser class for IBM Domino Server. +Sisimai::Lhost::Domino - bounce mail decoder class for HCL Domino L. =head1 SYNOPSIS @@ -178,8 +178,8 @@ Sisimai::Lhost::Domino - bounce mail parser class for IBM Domino Server. =head1 DESCRIPTION -Sisimai::Lhost::Domino parses a bounce email which created by IBM Domino Server. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by HCL Domino L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -191,8 +191,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -207,3 +207,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/DragonFly.pm b/lib/Sisimai/Lhost/DragonFly.pm index 67df0bc9..aa3a877d 100644 --- a/lib/Sisimai/Lhost/DragonFly.pm +++ b/lib/Sisimai/Lhost/DragonFly.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'DragonFly' } +sub description { 'DragonFly: https://www.dragonflybsd.org/handbook/mta/' } sub inquire { # Detect an error from DMA: DragonFly Mail Agent # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v5.0.4 my $class = shift; my $mhead = shift // return undef; @@ -120,7 +120,7 @@ __END__ =head1 NAME -Sisimai::Lhost::DragonFly - bounce mail parser class for C. +Sisimai::Lhost::DragonFly - bounce mail decoder class for DMA: DragonFly Mail Agent L. =head1 SYNOPSIS @@ -128,8 +128,8 @@ Sisimai::Lhost::DragonFly - bounce mail parser class for C parses a bounce email which created by C. -Methods in the module are called from only C. +C decodes a bounce email which created by DMA: DragonFly Mail Agent +L. Methods in the module are called from only C. =head1 CLASS METHODS @@ -141,7 +141,7 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as an array reference. +C method decodes a bounced email and return results as an array reference. See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/EZweb.pm b/lib/Sisimai/Lhost/EZweb.pm index 74af8d61..3cfe4389 100644 --- a/lib/Sisimai/Lhost/EZweb.pm +++ b/lib/Sisimai/Lhost/EZweb.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'au EZweb: http://www.au.kddi.com/mobile/' } +sub description { 'au EZweb: https://www.au.com/mobile/' } sub inquire { # Detect an error from EZweb # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -173,7 +173,7 @@ __END__ =head1 NAME -Sisimai::Lhost::EZweb - bounce mail parser class for C. +Sisimai::Lhost::EZweb - bounce mail decoder class for au EZweb L. =head1 SYNOPSIS @@ -181,8 +181,8 @@ Sisimai::Lhost::EZweb - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::EZweb parses a bounce email which created by C. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by au EZweb L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -194,8 +194,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/EinsUndEins.pm b/lib/Sisimai/Lhost/EinsUndEins.pm index 01e6bd5f..14707a2d 100644 --- a/lib/Sisimai/Lhost/EinsUndEins.pm +++ b/lib/Sisimai/Lhost/EinsUndEins.pm @@ -11,7 +11,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decodes or the arguments are missing # @since v4.1.9 my $class = shift; my $mhead = shift // return undef; @@ -124,7 +124,7 @@ __END__ =head1 NAME -Sisimai::Lhost::EinsUndEins - bounce mail parser class for C<1&1>. +Sisimai::Lhost::EinsUndEins - bounce mail decoder class for 1&1 L. =head1 SYNOPSIS @@ -132,8 +132,8 @@ Sisimai::Lhost::EinsUndEins - bounce mail parser class for C<1&1>. =head1 DESCRIPTION -Sisimai::Lhost::EinsUndEins parses a bounce email which created by C<1&1>. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by 1&1 L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -145,8 +145,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Exchange2003.pm b/lib/Sisimai/Lhost/Exchange2003.pm index c6dea02a..9cfb51c7 100644 --- a/lib/Sisimai/Lhost/Exchange2003.pm +++ b/lib/Sisimai/Lhost/Exchange2003.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Microsoft Exchange Server 2003' } +sub description { 'Microsoft Exchange Server 2003: https://www.microsoft.com/microsoft-365/exchange/email' } sub inquire { # Detect an error from Microsoft Exchange Server 2003 # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.1 my $class = shift; my $mhead = shift // return undef; @@ -230,7 +230,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Exchange2003 - bounce mail parser class for C. +Sisimai::Lhost::Exchange2003 - bounce mail decoder class for Microsft Exchange Server 2003 L. =head1 SYNOPSIS @@ -238,8 +238,9 @@ Sisimai::Lhost::Exchange2003 - bounce mail parser class for C. -Methods in the module are called from only Sisimai::Message. +C decodes a bounce email which created by Microsoft Exchange Server 2003 +L. Methods in the module are called from +only C. =head1 CLASS METHODS @@ -252,8 +253,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -268,3 +269,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/Exchange2007.pm b/lib/Sisimai/Lhost/Exchange2007.pm index e9de49fe..32da3e86 100644 --- a/lib/Sisimai/Lhost/Exchange2007.pm +++ b/lib/Sisimai/Lhost/Exchange2007.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Microsoft Exchange Server 2007' } +sub description { 'Microsoft Exchange Server 2007: https://www.microsoft.com/microsoft-365/exchange/email' } sub inquire { # Detect an error from Microsoft Exchange Server 2007 # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.1 my $class = shift; my $mhead = shift // return undef; @@ -168,7 +168,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Exchange2007 - bounce mail parser class for C. +Sisimai::Lhost::Exchange2007 - bounce mail decoder class for Microsft Exchange Server 2007 L. =head1 SYNOPSIS @@ -176,8 +176,9 @@ Sisimai::Lhost::Exchange2007 - bounce mail parser class for C. -Methods in the module are called from only Sisimai::Message. +C decodes a bounce email which created by Microsoft Exchange Server 2007 +L. Methods in the module are called from only +C. =head1 CLASS METHODS @@ -189,8 +190,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -205,3 +206,4 @@ Copyright (C) 2016-2021,2023,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/Exim.pm b/lib/Sisimai/Lhost/Exim.pm index acd6de69..b41651e5 100644 --- a/lib/Sisimai/Lhost/Exim.pm +++ b/lib/Sisimai/Lhost/Exim.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -499,7 +499,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Exim - bounce mail parser class for C. +Sisimai::Lhost::Exim - bounce mail decoder class for Exim Internet Mailer L. =head1 SYNOPSIS @@ -507,8 +507,8 @@ Sisimai::Lhost::Exim - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Exim parses a bounce email which created by C. Methods in the module are called -from only Sisimai::Message. +C decodes a bounce email which created by Exim Internet Mailer L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -520,8 +520,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -536,3 +536,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/FML.pm b/lib/Sisimai/Lhost/FML.pm index 7c228e35..94709112 100644 --- a/lib/Sisimai/Lhost/FML.pm +++ b/lib/Sisimai/Lhost/FML.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'fml mailing list server/manager' }; +sub description { 'fml mailing list server/manager: https://www.fml.org/' }; sub inquire { # Detect an error from fml mailing list server/manager # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.22.3 my $class = shift; my $mhead = shift // return undef; @@ -114,7 +114,7 @@ __END__ =head1 NAME -Sisimai::Lhost::FML - bounce mail parser class for FML (fml.org). +Sisimai::Lhost::FML - bounce mail decoder class for FML L. =head1 SYNOPSIS @@ -122,8 +122,8 @@ Sisimai::Lhost::FML - bounce mail parser class for FML (fml.org). =head1 DESCRIPTION -Sisimai::Lhost::FML parses a bounce email which created by C. -Methods in the module are called from only Sisimai::Message. +C decodes a bounce email which created by fml mailing list server/manager +L. Methods in the module are called from only C. =head1 CLASS METHODS @@ -135,8 +135,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Facebook.pm b/lib/Sisimai/Lhost/Facebook.pm index 38b15a5a..dadb1765 100644 --- a/lib/Sisimai/Lhost/Facebook.pm +++ b/lib/Sisimai/Lhost/Facebook.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decodes or the arguments are missing # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -195,7 +195,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Facebook - bounce mail parser class for C. +Sisimai::Lhost::Facebook - bounce mail decoder class for Facebook L. =head1 SYNOPSIS @@ -203,8 +203,8 @@ Sisimai::Lhost::Facebook - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Facebook parses a bounce email which created by C. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by Facebook L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -216,8 +216,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -232,3 +232,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/GMX.pm b/lib/Sisimai/Lhost/GMX.pm index 74e6c876..79c13444 100644 --- a/lib/Sisimai/Lhost/GMX.pm +++ b/lib/Sisimai/Lhost/GMX.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'GMX: https://www.gmx.net' } +sub description { 'GMX: https://gmx.net/' } sub inquire { # Detect an error from GMX and mail.com # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.4 my $class = shift; my $mhead = shift // return undef; @@ -122,7 +122,7 @@ __END__ =head1 NAME -Sisimai::Lhost::GMX - bounce mail parser class for C and mail.com. +Sisimai::Lhost::GMX - bounce mail decoder class for GMX L and mail.com. =head1 SYNOPSIS @@ -130,8 +130,8 @@ Sisimai::Lhost::GMX - bounce mail parser class for C and mail.com. =head1 DESCRIPTION -Sisimai::Lhost::GMX parses a bounce email which created by C. Methods in the module are called -from only Sisimai::Message. +C decodes a bounce email which created by GMX L. Methods in +the module are called from only C. =head1 CLASS METHODS @@ -143,8 +143,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/GSuite.pm b/lib/Sisimai/Lhost/GSuite.pm index dfad02d2..595ed3ea 100644 --- a/lib/Sisimai/Lhost/GSuite.pm +++ b/lib/Sisimai/Lhost/GSuite.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'G Suite: https://gsuite.google.com/' } +sub description { 'G Suite: https://workspace.google.com/' } sub inquire { # Detect an error from G Suite (Transfer from G Suite to a destination host) # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.21.0 my $class = shift; my $mhead = shift // return undef; @@ -197,7 +197,7 @@ __END__ =head1 NAME -Sisimai::Lhost::GSuite - bounce mail parser class for C. +Sisimai::Lhost::GSuite - bounce mail decoder class for Google Workspace L =head1 SYNOPSIS @@ -205,8 +205,8 @@ Sisimai::Lhost::GSuite - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::GSuite parses a bounce email which created by C. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by Google Workspace L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -218,8 +218,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Gmail.pm b/lib/Sisimai/Lhost/Gmail.pm index 4dfa1cef..ab78b4b3 100644 --- a/lib/Sisimai/Lhost/Gmail.pm +++ b/lib/Sisimai/Lhost/Gmail.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Gmail: https://mail.google.com' } +sub description { 'Gmail: https://mail.google.com/' } sub inquire { # Detect an error from Gmail # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -262,7 +262,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Gmail - bounce mail parser class for C. +Sisimai::Lhost::Gmail - bounce mail decoder class for Gmail L. =head1 SYNOPSIS @@ -270,8 +270,8 @@ Sisimai::Lhost::Gmail - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Gmail parses a bounce email which created by C. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by Gmail L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -283,8 +283,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/GoogleGroups.pm b/lib/Sisimai/Lhost/GoogleGroups.pm index 73c0ecd0..94673890 100644 --- a/lib/Sisimai/Lhost/GoogleGroups.pm +++ b/lib/Sisimai/Lhost/GoogleGroups.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.25.6 my $class = shift; my $mhead = shift // return undef; @@ -84,7 +84,7 @@ __END__ =head1 NAME -Sisimai::Lhost::GoogleGroups - bounce mail parser class for C. +Sisimai::Lhost::GoogleGroups - bounce mail decoder class for Google Groups L. =head1 SYNOPSIS @@ -92,8 +92,8 @@ Sisimai::Lhost::GoogleGroups - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::GoogleGroups parses a bounce email which created by C. Methods in the -module are called from only Sisimai::Message. +C decodes a bounce email which created by Google Groups L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -105,8 +105,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/IMailServer.pm b/lib/Sisimai/Lhost/IMailServer.pm index 2cd6ad05..b915022d 100644 --- a/lib/Sisimai/Lhost/IMailServer.pm +++ b/lib/Sisimai/Lhost/IMailServer.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'IPSWITCH IMail Server' } +sub description { 'Progress iMail Server: https://community.progress.com/s/products/imailserver' } sub inquire { # Detect an error from IMailServer # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.1 my $class = shift; my $mhead = shift // return undef; @@ -106,7 +106,7 @@ __END__ =head1 NAME -Sisimai::Lhost::IMailServer - bounce mail parser class for C. +Sisimai::Lhost::IMailServer - bounce mail decoder class for iMail Server L. =head1 SYNOPSIS @@ -114,8 +114,9 @@ Sisimai::Lhost::IMailServer - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::IMailServer parses a bounce email which created by C. Methods -in the module are called from only Sisimai::Message. +C decodes a bounce email which created by Progress iMail Server +L. Methods in the module are called from +only C. =head1 CLASS METHODS @@ -127,8 +128,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/InterScanMSS.pm b/lib/Sisimai/Lhost/InterScanMSS.pm index 12c19424..46ca4aea 100644 --- a/lib/Sisimai/Lhost/InterScanMSS.pm +++ b/lib/Sisimai/Lhost/InterScanMSS.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Trend Micro InterScan Messaging Security Suite' } +sub description { 'Trend Micro InterScan Messaging Security Suite: https://www.trendmicro.com/en_us/business/products/user-protection/sps/email-and-collaboration/interscan-messaging.html' } sub inquire { # Detect an error from InterScanMSS # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.2 my $class = shift; my $mhead = shift // return undef; @@ -93,7 +93,8 @@ __END__ =head1 NAME -Sisimai::Lhost::InterScanMSS - bounce mail parser class for C. +Sisimai::Lhost::InterScanMSS - bounce mail decoder class for Trend Micro InterScan Messaging Security +Suite L. =head1 SYNOPSIS @@ -101,8 +102,9 @@ Sisimai::Lhost::InterScanMSS - bounce mail parser class for C. -Methods in the module are called from only Sisimai::Message. +C decodes a bounce email which created by Trend Micro InterScan Messaging +Security Suite L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -114,8 +116,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/KDDI.pm b/lib/Sisimai/Lhost/KDDI.pm index 20345cde..6c600b88 100644 --- a/lib/Sisimai/Lhost/KDDI.pm +++ b/lib/Sisimai/Lhost/KDDI.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -111,7 +111,7 @@ __END__ =head1 NAME -Sisimai::Lhost::KDDI - bounce mail parser class for C. +Sisimai::Lhost::KDDI - bounce mail decoder class for au by KDDI L =head1 SYNOPSIS @@ -119,8 +119,8 @@ Sisimai::Lhost::KDDI - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::KDDI parses a bounce email which created by C. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by au by KDDI L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -132,8 +132,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -148,3 +148,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/MXLogic.pm b/lib/Sisimai/Lhost/MXLogic.pm index 2e849757..03861302 100644 --- a/lib/Sisimai/Lhost/MXLogic.pm +++ b/lib/Sisimai/Lhost/MXLogic.pm @@ -11,7 +11,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.1 my $class = shift; my $mhead = shift // return undef; @@ -192,7 +192,7 @@ __END__ =head1 NAME -Sisimai::Lhost::MXLogic - bounce mail parser class for C. +Sisimai::Lhost::MXLogic - bounce mail decoder class for McAfee SAAS (formerly MX Logic). =head1 SYNOPSIS @@ -200,8 +200,8 @@ Sisimai::Lhost::MXLogic - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::MXLogic parses a bounce email which created by C. -Methods in the module are called from only Sisimai::Message. +C decodes a bounce email which created by McAfee SaaS (formerly MX Logic). +Methods in the module are called from only C. =head1 CLASS METHODS @@ -213,8 +213,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -229,3 +229,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/MailFoundry.pm b/lib/Sisimai/Lhost/MailFoundry.pm index 95d81508..e597ca46 100644 --- a/lib/Sisimai/Lhost/MailFoundry.pm +++ b/lib/Sisimai/Lhost/MailFoundry.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'MailFoundry' } +sub description { 'MailFoundry: https://www.barracuda.com/' } sub inquire { # Detect an error from MailFoundry # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.1 my $class = shift; my $mhead = shift // return undef; @@ -92,7 +92,7 @@ __END__ =head1 NAME -Sisimai::Lhost::MailFoundry - bounce mail parser class for C. +Sisimai::Lhost::MailFoundry - bounce mail decoder class for MailFoundry L. =head1 SYNOPSIS @@ -100,8 +100,8 @@ Sisimai::Lhost::MailFoundry - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::MailFoundry parses a bounce email which created by C. Methods in the -module are called from only Sisimai::Message. +C decodes a bounce email which created by MailFoundry L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -113,8 +113,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/MailMarshalSMTP.pm b/lib/Sisimai/Lhost/MailMarshalSMTP.pm index a0bd7beb..9b506799 100644 --- a/lib/Sisimai/Lhost/MailMarshalSMTP.pm +++ b/lib/Sisimai/Lhost/MailMarshalSMTP.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Trustwave Secure Email Gateway' } +sub description { 'Trustwave Secure Email Gateway: https://www.trustwave.com/en-us/services/email-security/' } sub inquire { # Detect an error from MailMarshalSMTP # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.9 my $class = shift; my $mhead = shift // return undef; @@ -131,7 +131,8 @@ __END__ =head1 NAME -Sisimai::Lhost::MailMarshalSMTP - bounce mail parser class for C. +Sisimai::Lhost::MailMarshalSMTP - bounce mail decoder class for Trustwave Secure Email Gateway +L. =head1 SYNOPSIS @@ -139,8 +140,9 @@ Sisimai::Lhost::MailMarshalSMTP - bounce mail parser class for C: -formerly MailMarshal SMTP. Methods in the module are called from only Sisimai::Message. +C decodes a bounce email which created by Trustwave Secure Email +Gateway L: formerly MailMarshal SMTP. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -152,8 +154,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -169,4 +171,3 @@ This software is distributed under The BSD 2-Clause License. =cut - diff --git a/lib/Sisimai/Lhost/MailRu.pm b/lib/Sisimai/Lhost/MailRu.pm index 5122af52..2a9864f4 100644 --- a/lib/Sisimai/Lhost/MailRu.pm +++ b/lib/Sisimai/Lhost/MailRu.pm @@ -11,7 +11,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.4 my $class = shift; my $mhead = shift // return undef; @@ -214,7 +214,7 @@ __END__ =head1 NAME -Sisimai::Lhost::MailRu - bounce mail parser class for C<@mail.ru>. +Sisimai::Lhost::MailRu - bounce mail decoder class for @mail.ru L. =head1 SYNOPSIS @@ -222,8 +222,8 @@ Sisimai::Lhost::MailRu - bounce mail parser class for C<@mail.ru>. =head1 DESCRIPTION -Sisimai::Lhost::MailRu parses a bounce email which created by C<@mail.ru>. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by @mail.ru L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -235,8 +235,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -251,3 +251,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/McAfee.pm b/lib/Sisimai/Lhost/McAfee.pm index 2b153f41..0b29ca31 100644 --- a/lib/Sisimai/Lhost/McAfee.pm +++ b/lib/Sisimai/Lhost/McAfee.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.1 my $class = shift; my $mhead = shift // return undef; @@ -114,7 +114,7 @@ __END__ =head1 NAME -Sisimai::Lhost::McAfee - bounce mail parser class for C. +Sisimai::Lhost::McAfee - bounce mail decode class for McAfee Email Appliance. =head1 SYNOPSIS @@ -122,8 +122,8 @@ Sisimai::Lhost::McAfee - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::McAfee parses a bounce email which created by C. Methods in -the module are called from only Sisimai::Message. +C decodes a bounce email which created by McAfee Email Appliance. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -135,8 +135,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/MessageLabs.pm b/lib/Sisimai/Lhost/MessageLabs.pm index f9bdc599..0dc8c451 100644 --- a/lib/Sisimai/Lhost/MessageLabs.pm +++ b/lib/Sisimai/Lhost/MessageLabs.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Symantec.cloud http://www.messagelabs.com' } +sub description { 'Email Security (formerly Messaging Security): https://www.broadcom.com/products/cybersecurity/email' } sub inquire { # Detect an error from MessageLabs.com # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.10 my $class = shift; my $mhead = shift // return undef; @@ -122,7 +122,8 @@ __END__ =head1 NAME -Sisimai::Lhost::MessageLabs - bounce mail parser class for C. +Sisimai::Lhost::MessageLabs - bounce mail decode class for Email Security (formerly Messaging Security) +L =head1 SYNOPSIS @@ -130,8 +131,10 @@ Sisimai::Lhost::MessageLabs - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::MessageLabs parses a bounce email which created by C: formerly known -as C. Methods in the module are called from only Sisimai::Message. +C decodes a bounce email which created by Email Security (formerly Messaging +Security) L (formerly Symantec.cloud: formerly +known as MessageLabs L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -143,8 +146,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/MessagingServer.pm b/lib/Sisimai/Lhost/MessagingServer.pm index 388364ff..d54d69cb 100644 --- a/lib/Sisimai/Lhost/MessagingServer.pm +++ b/lib/Sisimai/Lhost/MessagingServer.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Oracle Communications Messaging Server' } +sub description { 'Oracle Communications Messaging Server: https://docs.oracle.com/en/industries/communications/messaging-server/index.html' } sub inquire { # Detect an error from Oracle Communications Messaging Server # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.3 my $class = shift; my $mhead = shift // return undef; @@ -162,8 +162,8 @@ __END__ =head1 NAME -Sisimai::Lhost::MessagingServer - bounce mail parser class for C -and C. +Sisimai::Lhost::MessagingServer - bounce mail decoder class for C +and C L. =head1 SYNOPSIS @@ -171,8 +171,9 @@ and C. =head1 DESCRIPTION -Sisimai::Lhost::MessagingServer parses a bounce email which created by C -and C. Methods in the module are called from only Sisimai::Message. +C decodes a bounce email which created by Oracle Communications +Messaging Server L +and Sun Java System Messaging Server. Methods in the module are called from only C. =head1 CLASS METHODS @@ -184,8 +185,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Notes.pm b/lib/Sisimai/Lhost/Notes.pm index eb21f69f..68ac3bc0 100644 --- a/lib/Sisimai/Lhost/Notes.pm +++ b/lib/Sisimai/Lhost/Notes.pm @@ -5,13 +5,13 @@ use strict; use warnings; use Encode; -sub description { 'Lotus Notes' } +sub description { 'HCL Notes' } sub inquire { # Detect an error from Lotus Notes # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.1 my $class = shift; my $mhead = shift // return undef; @@ -128,7 +128,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Notes - bounce mail parser class for C. +Sisimai::Lhost::Notes - bounce mail decoder class for HCL Notes (formerly Lotus Notes Server). =head1 SYNOPSIS @@ -136,8 +136,8 @@ Sisimai::Lhost::Notes - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Notes parses a bounce email which created by C. Methods in the -module are called from only Sisimai::Message. +C decodes a bounce email which created by HCL Notes (formerly IBM Notes +(formerly Lotus Notes Server)). Methods in the module are called from only C. =head1 CLASS METHODS @@ -149,8 +149,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Office365.pm b/lib/Sisimai/Lhost/Office365.pm index 225d0ea5..b3723c1c 100644 --- a/lib/Sisimai/Lhost/Office365.pm +++ b/lib/Sisimai/Lhost/Office365.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Microsoft Office 365: https://office.microsoft.com/' } +sub description { 'Microsoft 365: https://office.microsoft.com/' } sub inquire { # Detect an error from Microsoft Office 365 # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.3 my $class = shift; my $mhead = shift // return undef; @@ -242,7 +242,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Office365 - bounce mail parser class for Microsoft Office 365. +Sisimai::Lhost::Office365 - bounce mail decoder class for Microsoft 365 L. =head1 SYNOPSIS @@ -250,8 +250,8 @@ Sisimai::Lhost::Office365 - bounce mail parser class for Microsoft Office 365. =head1 DESCRIPTION -Sisimai::Lhost::Office365 parses a bounce email which created by Microsoft Office 365. Methods in -the module are called from only Sisimai::Message. +C decodes a bounce email which created by Microsoft 365 L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -263,8 +263,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/OpenSMTPD.pm b/lib/Sisimai/Lhost/OpenSMTPD.pm index a3bccf46..5f16e162 100644 --- a/lib/Sisimai/Lhost/OpenSMTPD.pm +++ b/lib/Sisimai/Lhost/OpenSMTPD.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'OpenSMTPD' } +sub description { 'OpenSMTPD: https://www.opensmtpd.org/' } sub inquire { # Detect an error from OpenSMTPD # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -142,7 +142,7 @@ __END__ =head1 NAME -Sisimai::Lhost::OpenSMTPD - bounce mail parser class for C. +Sisimai::Lhost::OpenSMTPD - bounce mail decoder class for OpenSMTPD L. =head1 SYNOPSIS @@ -150,8 +150,8 @@ Sisimai::Lhost::OpenSMTPD - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::OpenSMTPD parses a bounce email which created by C. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by OpenSMTPD L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -163,8 +163,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -179,3 +179,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/Outlook.pm b/lib/Sisimai/Lhost/Outlook.pm index fdb77525..10d473da 100644 --- a/lib/Sisimai/Lhost/Outlook.pm +++ b/lib/Sisimai/Lhost/Outlook.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.3 my $class = shift; my $mhead = shift // return undef; @@ -135,7 +135,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Outlook - bounce mail parser class for C. +Sisimai::Lhost::Outlook - bounce mail decoder class for outlook.com L. =head1 SYNOPSIS @@ -143,8 +143,8 @@ Sisimai::Lhost::Outlook - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Outlook parses a bounce email which created by C. Methods in -the module are called from only Sisimai::Message. +C decodes a bounce email which created by Microsoft outlook.com L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -156,8 +156,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Postfix.pm b/lib/Sisimai/Lhost/Postfix.pm index 1271b69a..7dcba37a 100644 --- a/lib/Sisimai/Lhost/Postfix.pm +++ b/lib/Sisimai/Lhost/Postfix.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Postfix' } +sub description { 'Postfix: https://www.postfix.org/' } sub inquire { # Parse bounce messages from Postfix # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -293,7 +293,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Postfix - bounce mail parser class for C. +Sisimai::Lhost::Postfix - bounce mail decoder class for Postfix L. =head1 SYNOPSIS @@ -301,8 +301,8 @@ Sisimai::Lhost::Postfix - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Postfix parses a bounce email which created by C. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by Postfix L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -314,8 +314,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/PowerMTA.pm b/lib/Sisimai/Lhost/PowerMTA.pm index 58fe4e62..d4e531ac 100644 --- a/lib/Sisimai/Lhost/PowerMTA.pm +++ b/lib/Sisimai/Lhost/PowerMTA.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'PowerMTA: https://www.sparkpost.com/powermta/' } +sub description { 'PowerMTA: https://bird.com/email/power-mta' } sub inquire { # Detect an error from PowerMTA # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.25.6 my $class = shift; my $mhead = shift // return undef; @@ -123,7 +123,7 @@ __END__ =head1 NAME -Sisimai::Lhost::PowerMTA - bounce mail parser class for C. +Sisimai::Lhost::PowerMTA - bounce mail decoder class for PowerMTA L. =head1 SYNOPSIS @@ -131,8 +131,8 @@ Sisimai::Lhost::PowerMTA - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::PowerMTA parses a bounce email which created by C. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by PowerMTA L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -144,8 +144,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/ReceivingSES.pm b/lib/Sisimai/Lhost/ReceivingSES.pm index 4fafc366..0ffd1a6d 100644 --- a/lib/Sisimai/Lhost/ReceivingSES.pm +++ b/lib/Sisimai/Lhost/ReceivingSES.pm @@ -4,14 +4,14 @@ use v5.26; use strict; use warnings; -# https://aws.amazon.com/ses/ sub description { 'Amazon SES(Receiving): https://aws.amazon.com/ses/' }; sub inquire { # Detect an error from Amazon SES/Receiving # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing + # @see https://aws.amazon.com/ses/ # @since v4.1.29 my $class = shift; my $mhead = shift // return undef; @@ -133,7 +133,7 @@ __END__ =head1 NAME -Sisimai::Lhost::ReceivingSES - bounce mail parser class for C. +Sisimai::Lhost::ReceivingSES - bounce mail decoder class for Amazon SES C. =head1 SYNOPSIS @@ -141,8 +141,8 @@ Sisimai::Lhost::ReceivingSES - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::ReceivingSES parses a bounce email which created by C. -Methods in the module are called from only Sisimai::Message. +C decodes a bounce email which created by Amazon Simple Email Service +L. Methods in the module are called from only C. =head1 CLASS METHODS @@ -154,8 +154,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/SendGrid.pm b/lib/Sisimai/Lhost/SendGrid.pm index c374e685..9a186845 100644 --- a/lib/Sisimai/Lhost/SendGrid.pm +++ b/lib/Sisimai/Lhost/SendGrid.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'SendGrid: https://sendgrid.com/' } +sub description { 'Twilio SendGrid: https://sendgrid.com/' } sub inquire { # Detect an error from SendGrid # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.2 my $class = shift; my $mhead = shift // return undef; @@ -174,7 +174,7 @@ __END__ =head1 NAME -Sisimai::Lhost::SendGrid - bounce mail parser class for C. +Sisimai::Lhost::SendGrid - bounce mail decoder class for Twilio SendGrid L. =head1 SYNOPSIS @@ -182,8 +182,8 @@ Sisimai::Lhost::SendGrid - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::SendGrid parses a bounce email which created by C. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by Twilio SendGrid L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -195,8 +195,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -211,3 +211,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/Sendmail.pm b/lib/Sisimai/Lhost/Sendmail.pm index 27f4dad2..3c64a405 100644 --- a/lib/Sisimai/Lhost/Sendmail.pm +++ b/lib/Sisimai/Lhost/Sendmail.pm @@ -4,13 +4,14 @@ use v5.26; use strict; use warnings; -sub description { 'V8Sendmail: /usr/sbin/sendmail' } +sub description { 'Sendmail Open Source: https://sendmail.org/' } sub inquire { # Parse bounce messages from Sendmail # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing + # @see https://www.proofpoint.com/us/products/email-protection/open-source-email-solution # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -216,7 +217,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Sendmail - bounce mail parser class for v8 Sendmail. +Sisimai::Lhost::Sendmail - bounce mail decoder class for Sendmail Open Source L. =head1 SYNOPSIS @@ -224,8 +225,8 @@ Sisimai::Lhost::Sendmail - bounce mail parser class for v8 Sendmail. =head1 DESCRIPTION -Sisimai::Lhost::Sendmail parses a bounce email which created by v8 Sendmail. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by Sendmail Open Source L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -237,8 +238,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -253,3 +254,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/SurfControl.pm b/lib/Sisimai/Lhost/SurfControl.pm index 90b53503..6d5eaf15 100644 --- a/lib/Sisimai/Lhost/SurfControl.pm +++ b/lib/Sisimai/Lhost/SurfControl.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.2 my $class = shift; my $mhead = shift // return undef; @@ -79,7 +79,7 @@ sub inquire { $v->{'diagnosis'} = Sisimai::String->sweep(substr($e, $p2 + 2,)); } else { - # Fallback, parse RFC3464 headers. + # Fallback, read RFC3464 headers. if( my $f = Sisimai::RFC1894->match($e) ) { # $e matched with any field defined in RFC3464 next unless my $o = Sisimai::RFC1894->field($e); @@ -111,7 +111,7 @@ __END__ =head1 NAME -Sisimai::Lhost::SurfControl - bounce mail parser class for C. +Sisimai::Lhost::SurfControl - bounce mail decoder class for SurfControl. =head1 SYNOPSIS @@ -119,8 +119,8 @@ Sisimai::Lhost::SurfControl - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::SurfControl parses a bounce email which created by C. Methods -in the module are called from only Sisimai::Message. +C decodes a bounce email which created by WebSense SurfControl. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -132,8 +132,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/V5sendmail.pm b/lib/Sisimai/Lhost/V5sendmail.pm index b5225136..80c79d35 100644 --- a/lib/Sisimai/Lhost/V5sendmail.pm +++ b/lib/Sisimai/Lhost/V5sendmail.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.2 my $class = shift; my $mhead = shift // return undef; @@ -160,7 +160,7 @@ __END__ =head1 NAME -Sisimai::Lhost::V5sendmail - bounce mail parser class for C. +Sisimai::Lhost::V5sendmail - bounce mail decoder class for V5 Sendmail. =head1 SYNOPSIS @@ -168,8 +168,8 @@ Sisimai::Lhost::V5sendmail - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::V5sendmail parses a bounce email which created by C or any email -appliances based on C. Methods in the module are called from only Sisimai::Message. +C decodes a bounce email which created by Sendmail version 5 or any email +appliances based on Sendmail version 5. Methods in the module are called from only C. =head1 CLASS METHODS @@ -181,8 +181,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -197,3 +197,4 @@ Copyright (C) 2014-2021,2023,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/Verizon.pm b/lib/Sisimai/Lhost/Verizon.pm index 65fcd859..75c1b89d 100644 --- a/lib/Sisimai/Lhost/Verizon.pm +++ b/lib/Sisimai/Lhost/Verizon.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Verizon Wireless: https://www.verizonwireless.com' } +sub description { 'Verizon: https://www.verizon.com/' } sub inquire { # Detect an error from Verizon # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -167,7 +167,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Verizon - bounce mail parser class for C. +Sisimai::Lhost::Verizon - bounce mail decoder class for Verizon L. =head1 SYNOPSIS @@ -175,8 +175,8 @@ Sisimai::Lhost::Verizon - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Verizon parses a bounce email which created by C. Methods in the -module are called from only Sisimai::Message. +C decodes a bounce email which created by Verizon L. +Methods in the module are called from only Sisimai::Message. =head1 CLASS METHODS @@ -188,8 +188,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/X1.pm b/lib/Sisimai/Lhost/X1.pm index e1134f91..648d04d0 100644 --- a/lib/Sisimai/Lhost/X1.pm +++ b/lib/Sisimai/Lhost/X1.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.3 my $class = shift; my $mhead = shift // return undef; @@ -83,7 +83,7 @@ __END__ =head1 NAME -Sisimai::Lhost::X1 - bounce mail parser class for C. +Sisimai::Lhost::X1 - bounce mail decoder class for X1. =head1 SYNOPSIS @@ -91,8 +91,8 @@ Sisimai::Lhost::X1 - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::X1 parses a bounce email which created by Unknown MTA #1. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by Unknown MTA #1. Methods in the module +are called from only C. =head1 CLASS METHODS @@ -104,8 +104,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/X2.pm b/lib/Sisimai/Lhost/X2.pm index e5d06c66..905b6899 100644 --- a/lib/Sisimai/Lhost/X2.pm +++ b/lib/Sisimai/Lhost/X2.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.7 my $class = shift; my $mhead = shift // return undef; @@ -78,7 +78,7 @@ __END__ =head1 NAME -Sisimai::Lhost::X2 - bounce mail parser class for C. +Sisimai::Lhost::X2 - bounce mail decoder class for X2. =head1 SYNOPSIS @@ -86,8 +86,8 @@ Sisimai::Lhost::X2 - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::X2 parses a bounce email which created by Unknown MTA #2. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by Unknown MTA #2. Methods in the module +are called from only C. =head1 CLASS METHODS @@ -99,8 +99,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/X3.pm b/lib/Sisimai/Lhost/X3.pm index bbd02ef5..2b3b5b8e 100644 --- a/lib/Sisimai/Lhost/X3.pm +++ b/lib/Sisimai/Lhost/X3.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.9 my $class = shift; my $mhead = shift // return undef; @@ -101,7 +101,7 @@ __END__ =head1 NAME -Sisimai::Lhost::X3 - bounce mail parser class for C. +Sisimai::Lhost::X3 - bounce mail decoder class for X3. =head1 SYNOPSIS @@ -109,8 +109,8 @@ Sisimai::Lhost::X3 - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::X3 parses a bounce email which created by Unknown MTA #3. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by Unknown MTA #3. Methods in the module +are called from only C. =head1 CLASS METHODS @@ -122,8 +122,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -138,3 +138,4 @@ Copyright (C) 2014-2021,2023,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Lhost/X4.pm b/lib/Sisimai/Lhost/X4.pm index 5e3a9d83..30492918 100644 --- a/lib/Sisimai/Lhost/X4.pm +++ b/lib/Sisimai/Lhost/X4.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.23 my $class = shift; my $mhead = shift // return undef; @@ -277,7 +277,7 @@ __END__ =head1 NAME -Sisimai::Lhost::X4 - bounce mail parser class for Unknown MTA which is developed as a C clone. +Sisimai::Lhost::X4 - bounce mail decoder class for Unknown MTA which is developed as a qmail clone. =head1 SYNOPSIS @@ -285,8 +285,8 @@ Sisimai::Lhost::X4 - bounce mail parser class for Unknown MTA which is developed =head1 DESCRIPTION -Sisimai::Lhost::X4 parses a bounce email which created by some C clone. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by some qmail clone. Methods in the module +are called from only C. =head1 CLASS METHODS @@ -298,8 +298,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/X5.pm b/lib/Sisimai/Lhost/X5.pm index 93f62b5b..88c7c5df 100644 --- a/lib/Sisimai/Lhost/X5.pm +++ b/lib/Sisimai/Lhost/X5.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.13.0 my $class = shift; my $mhead = shift // return undef; @@ -120,7 +120,7 @@ __END__ =head1 NAME -Sisimai::Lhost::X5 - bounce mail parser class for unknown MTA #5. +Sisimai::Lhost::X5 - bounce mail decoder class for unknown MTA #5. =head1 SYNOPSIS @@ -128,8 +128,8 @@ Sisimai::Lhost::X5 - bounce mail parser class for unknown MTA #5. =head1 DESCRIPTION -Sisimai::Lhost::X5 parses a bounce email which created by Unknown MTA #5. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by Unknown MTA #5. Methods in the module +are called from only C. =head1 CLASS METHODS @@ -141,8 +141,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/X6.pm b/lib/Sisimai/Lhost/X6.pm index 710921fa..ecb64a9b 100644 --- a/lib/Sisimai/Lhost/X6.pm +++ b/lib/Sisimai/Lhost/X6.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.25.6 my $class = shift; my $mhead = shift // return undef; @@ -98,7 +98,7 @@ __END__ =head1 NAME -Sisimai::Lhost::X6 - bounce mail parser class for C. +Sisimai::Lhost::X6 - bounce mail decoder class for C. =head1 SYNOPSIS @@ -106,8 +106,8 @@ Sisimai::Lhost::X6 - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::X6 parses a bounce email which created by Unknown MTA #6. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by Unknown MTA #6. Methods in the module +are called from only C. =head1 CLASS METHODS @@ -119,8 +119,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Yahoo.pm b/lib/Sisimai/Lhost/Yahoo.pm index 1442dbb1..92fd072f 100644 --- a/lib/Sisimai/Lhost/Yahoo.pm +++ b/lib/Sisimai/Lhost/Yahoo.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Yahoo! MAIL: https://www.yahoo.com' } +sub description { 'Yahoo MAIL: https://mail.yahoo.com/' } sub inquire { # Detect an error from Yahoo! MAIL # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decodes or the arguments are missing # @since v4.1.3 my $class = shift; my $mhead = shift // return undef; @@ -107,7 +107,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Yahoo - bounce mail parser class for C. +Sisimai::Lhost::Yahoo - bounce mail decoder class for Yahoo Mail L. =head1 SYNOPSIS @@ -115,8 +115,8 @@ Sisimai::Lhost::Yahoo - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Yahoo parses a bounce email which created by C. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by Yahoo Mail L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -128,8 +128,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/Yandex.pm b/lib/Sisimai/Lhost/Yandex.pm index 437d65af..511c6321 100644 --- a/lib/Sisimai/Lhost/Yandex.pm +++ b/lib/Sisimai/Lhost/Yandex.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Yandex.Mail: https://www.yandex.ru' } +sub description { 'Yandex Mail: https://360.yandex.com/mail/' } sub inquire { # Detect an error from Yandex.Mail # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.6 my $class = shift; my $mhead = shift // return undef; @@ -127,7 +127,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Yandex - bounce mail parser class for C. +Sisimai::Lhost::Yandex - bounce mail decoder class for Yandex Mail L. =head1 SYNOPSIS @@ -135,8 +135,8 @@ Sisimai::Lhost::Yandex - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Yandex parses a bounce email which created by C. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by Yandex Mail L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -148,8 +148,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -165,4 +165,3 @@ This software is distributed under The BSD 2-Clause License. =cut - diff --git a/lib/Sisimai/Lhost/Zoho.pm b/lib/Sisimai/Lhost/Zoho.pm index fdc5e7f0..27915390 100644 --- a/lib/Sisimai/Lhost/Zoho.pm +++ b/lib/Sisimai/Lhost/Zoho.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Zoho Mail: https://www.zoho.com' } +sub description { 'Zoho Mail: https://www.zoho.com/mail/' } sub inquire { # Detect an error from Zoho Mail # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.7 my $class = shift; my $mhead = shift // return undef; @@ -117,7 +117,7 @@ __END__ =head1 NAME -Sisimai::Lhost::Zoho - bounce mail parser class for C. +Sisimai::Lhost::Zoho - bounce mail decoder class for Zoho Mail L. =head1 SYNOPSIS @@ -125,8 +125,8 @@ Sisimai::Lhost::Zoho - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::Zoho parses a bounce email which created by C. Methods in the module -are called from only Sisimai::Message. +C decodes a bounce email which created by Zoho Mail L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -138,8 +138,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/mFILTER.pm b/lib/Sisimai/Lhost/mFILTER.pm index 61ea13d7..e5e20548 100644 --- a/lib/Sisimai/Lhost/mFILTER.pm +++ b/lib/Sisimai/Lhost/mFILTER.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'Digital Arts m-FILTER' } +sub description { 'Digital Arts m-FILTER: https://www.daj.jp/bs/mf/' } sub inquire { # Detect an error from DigitalArts m-FILTER # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.1 my $class = shift; my $mhead = shift // return undef; @@ -126,7 +126,7 @@ __END__ =head1 NAME -Sisimai::Lhost::mFILTER - bounce mail parser class for C. +Sisimai::Lhost::mFILTER - bounce mail decoder class for Digital Arts m-FILTER L. =head1 SYNOPSIS @@ -134,8 +134,8 @@ Sisimai::Lhost::mFILTER - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::mFILTER parses a bounce email which created by C. Methods in -the module are called from only Sisimai::Message. +C decodes a bounce email which created by Digital Arts m-FILTER L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -147,7 +147,7 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message +C method decodes a bounced email and return results as a array reference. See Sisimai::Message for more details. =head1 AUTHOR diff --git a/lib/Sisimai/Lhost/qmail.pm b/lib/Sisimai/Lhost/qmail.pm index 1facf225..99fa698d 100644 --- a/lib/Sisimai/Lhost/qmail.pm +++ b/lib/Sisimai/Lhost/qmail.pm @@ -4,13 +4,13 @@ use v5.26; use strict; use warnings; -sub description { 'qmail' } +sub description { 'qmail: https://cr.yp.to/qmail.html' } sub inquire { # Detect an error from qmail # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.0.0 my $class = shift; my $mhead = shift // return undef; @@ -244,7 +244,7 @@ __END__ =head1 NAME -Sisimai::Lhost::qmail - bounce mail parser class for C. +Sisimai::Lhost::qmail - bounce mail decoder class for qmail L. =head1 SYNOPSIS @@ -252,8 +252,8 @@ Sisimai::Lhost::qmail - bounce mail parser class for C. =head1 DESCRIPTION -Sisimai::Lhost::qmail parses a bounce email which created by C. Methods in the module are -called from only Sisimai::Message. +C decodes a bounce email which created by qmail L. +Methods in the module are called from only C. =head1 CLASS METHODS @@ -265,8 +265,8 @@ C returns description string of this module. =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method decodes a bounced email and return results as a array reference. +See C for more details. =head1 AUTHOR @@ -281,3 +281,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/MDA.pm b/lib/Sisimai/MDA.pm index 40ee74dd..1ac5fbc3 100644 --- a/lib/Sisimai/MDA.pm +++ b/lib/Sisimai/MDA.pm @@ -148,14 +148,14 @@ Sisimai::MDA - Error message parser for MDA =head1 DESCRIPTION -Sisimai::MDA parse bounced email which created by some MDA, such as C, C, -C, and so on. This class is called from Sisimai::Message only. +C decodes bounced email which created by some MDA, such as Dovecot, C, +C, and so on. This class is called from C only. =head1 CLASS METHODS =head2 C, I)>> -C is a parser for detecting an error from mail delivery agent. +C is a decoder for detecting an error from the mail delivery agent. my $header = { 'from' => 'mailer-daemon@example.jp' }; my $string = 'mail.local: Disc quota exceeded'; @@ -180,3 +180,4 @@ Copyright (C) 2014-2016,2018-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Mail.pm b/lib/Sisimai/Mail.pm index 7a6cecaf..a639e871 100644 --- a/lib/Sisimai/Mail.pm +++ b/lib/Sisimai/Mail.pm @@ -100,8 +100,8 @@ Sisimai::Mail - Handler of Mbox/Maildir for reading each mail. =head1 DESCRIPTION -Sisimai::Mail is a handler for reading a UNIX mbox, a Maildir, or any email message input from STDIN, -variable. It is a wrapper class of the following child classes: +C is a handler for reading a UNIX mbox, a Maildir, or any email message input from +C variable. It is a wrapper class of the following child classes: * Sisimai::Mail::Mbox * Sisimai::Mail::Maildir @@ -112,7 +112,7 @@ variable. It is a wrapper class of the following child classes: =head2 C)>> -C is a constructor of Sisimai::Mail +C method is a constructor of C my $mailbox = Sisimai::Mail->new('/var/mail/root'); my $maildir = Sisimai::Mail->new('/home/nyaa/Maildir/cur'); @@ -123,27 +123,27 @@ C is a constructor of Sisimai::Mail =head2 C> -C returns the path to mbox or Maildir. +C method returns the path to the mbox or the Maildir. print $mailbox->path; # /var/mail/root -=head2 C> +=head2 C> -C Returns the name of data type +C method returns the name of the data type print $mailbox->kind; # mailbox or maildir, stdin, or memory. =head2 C> -C returns Sisimai::Mail::Mbox object or Sisimai::Mail::Maildir object. +C method returns the C object or the C object. my $o = $mailbox->mail; print ref $o; # Sisimai::Mail::Mbox =head2 C> -C works as a iterator for reading each email in mbox or Maildir. It calls Sisimai::Mail::Mbox->read -or Sisimai::Mail::Maildir->read method. +C method works as an iterator for reading each email in the mbox or the Maildir. It calls +Cread()> or Cread> methods. my $mailbox = Sisimai::Mail->new('/var/mail/neko'); while( my $r = $mailbox->read ) { @@ -163,3 +163,4 @@ Copyright (C) 2014-2016,2018-2021,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Mail/Maildir.pm b/lib/Sisimai/Mail/Maildir.pm index 9be0d7b5..98d47be5 100644 --- a/lib/Sisimai/Mail/Maildir.pm +++ b/lib/Sisimai/Mail/Maildir.pm @@ -50,7 +50,7 @@ sub new { } sub read { - # Maildir reader, works as a iterator. + # Maildir reader, works as an iterator. # @return [String] Contents of file in Maildir/ my $self = shift; return undef unless defined $self->{'dir'}; @@ -103,13 +103,13 @@ Sisimai::Mail::Maildir - Mailbox reader =head1 DESCRIPTION -Sisimai::Mail::Maildir is a reader for getting contents of each email in the Maildir/ directory. +C is a reader for getting contents of each email in the Maildir/ directory. =head1 CLASS METHODS =head2 C)>> -C is a constructor of Sisimai::Mail::Maildir +C method is a constructor of C my $maildir = Sisimai::Mail::Maildir->new('/home/neko/Maildir/new'); @@ -117,43 +117,43 @@ C is a constructor of Sisimai::Mail::Maildir =head2 C> -C returns the path to Maildir/ +C method returns the path to Maildir/ print $maildir->dir; # /home/neko/Maildir/new/ =head2 C> -C returns the path to each email in Maildir/ +C method returns the path to each email in Maildir/ print $maildir->path; # /home/neko/Maildir/new/1.eml =head2 C> -C returns current file name of the Maildir. +C method returns the current file name of the Maildir. print $maildir->file; =head2 C> -C returns the amount of email size which has been read +C method returns the amount of email size which has been read print $maildir->size; =head2 C> -C returns the number of emails which have been read in Maildir/ +C method returns the number of emails which have been read in the Maildir/ $maildir->offset; # 2 =head2 C> -C returns file handle object (IO::Dir) of the Maildir. +C meethod returns file handle object C of the Maildir. $maildir->handle->close; =head2 C> -C works as a iterator for reading each email in the Maildir. +C method works as an iterator for reading each email in the Maildir. my $maildir = Sisimai::Mail->new('/home/neko/Maildir/new'); while( my $r = $mailbox->read ) { @@ -173,3 +173,4 @@ Copyright (C) 2014-2016,2018-2021,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Mail/Mbox.pm b/lib/Sisimai/Mail/Mbox.pm index 3371fb70..e2d31053 100644 --- a/lib/Sisimai/Mail/Mbox.pm +++ b/lib/Sisimai/Mail/Mbox.pm @@ -39,7 +39,7 @@ sub new { } sub read { - # Mbox reader, works as a iterator. + # Mbox reader, works as an iterator. # @return [String] Contents of mbox my $self = shift; @@ -89,13 +89,13 @@ Sisimai::Mail::Mbox - Mailbox reader =head1 DESCRIPTION -Sisimai::Mail::Mbox is a mailbox file (UNIX mbox) reader. +C is a mailbox file (UNIX mbox) reader. =head1 CLASS METHODS =head2 C)>> -C is a constructor of Sisimai::Mail::Mbox +C method is a constructor of C my $mailbox = Sisimai::Mail::Mbox->new('/var/mail/root'); @@ -103,44 +103,44 @@ C is a constructor of Sisimai::Mail::Mbox =head2 C> -C returns the directory name of mbox +C method returns the directory name of the UNIX mbox print $mailbox->dir; # /var/mail =head2 C> -C returns the path to mbox. +C meethod returns the path to the mbox. print $mailbox->path; # /var/mail/root =head2 C> -C returns a file name of the mbox. +C method returns the file name of the mbox. print $mailbox->file; # root =head2 C> -C returns the file size of the mbox. +C method returns the file size of the mbox. print $mailbox->size; # 94515 =head2 C> -C returns offset position for seeking the mbox. The value of "offset" is bytes which have -already read. +C method returns the offset position for seeking the mbox. The value of C<"offset"> is a +bytes which have already read. print $mailbox->offset; # 0 =head2 C> -C returns file handle object (IO::File) of the mbox. +C method returns file handle object C of the mbox. $mailbox->handle->close; =head2 C> -C works as a iterator for reading each email in the mbox. +C method works as an iterator for reading each email in the mbox. my $mailbox = Sisimai::Mail->new('/var/mail/neko'); while( my $r = $mailbox->read ) { @@ -160,3 +160,4 @@ Copyright (C) 2014-2016,2018,2019,2021,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Mail/Memory.pm b/lib/Sisimai/Mail/Memory.pm index 8cd122d7..783f77d5 100644 --- a/lib/Sisimai/Mail/Memory.pm +++ b/lib/Sisimai/Mail/Memory.pm @@ -41,7 +41,7 @@ sub new { } sub read { - # Memory reader, works as a iterator. + # Memory reader, works as an iterator. # @return [String] Contents of a bounce mail my $self = shift; return undef unless scalar $self->{'payload'}->@*; @@ -69,13 +69,14 @@ Sisimai::Mail::Memory - Mailbox reader =head1 DESCRIPTION -Sisimai::Mail::Memory is a class for reading a mailbox, files in Maildir/, or JSON string from variable. +C is a class for reading a mailbox, files in Maildir/ from the value of the +specified variable. =head1 CLASS METHODS =head2 C)>> -C is a constructor of Sisimai::Mail::Memory +C method is a constructor of C my $mailtxt = 'From Mailer-Daemon ...'; my $mailobj = Sisimai::Mail::Memory->new(\$mailtxt); @@ -84,32 +85,32 @@ C is a constructor of Sisimai::Mail::Memory =head2 C> -C returns "" +C method returns a fixed string C<""> print $mailbox->path; # "" =head2 C> -C returns a memory size of the mailbox or JSON string. +C method returns a memory size of the mailbox print $mailobj->size; # 94515 =head2 C> -C returns an array reference to each email message or JSON string +C method returns an array reference to each email message print scalar $mailobj->payload->@*; # 17 =head2 C> -C returns an offset position for seeking "payload" list. The value of "offset" is an index -number which have already read. +C method returns the offset position for seeking C<"payload"> list. The value of C<"offset"> +is an index number which have already read. print $mailobj->offset; # 0 =head2 C> -C works as a iterator for reading each email in the mailbox. +C method works as an iterator for reading each email in the mailbox. my $mailtxt = 'From Mailer-Daemon ...'; my $mailobj = Sisimai::Mail->new(\$mailtxt); diff --git a/lib/Sisimai/Mail/STDIN.pm b/lib/Sisimai/Mail/STDIN.pm index aa991286..bfc7a96e 100644 --- a/lib/Sisimai/Mail/STDIN.pm +++ b/lib/Sisimai/Mail/STDIN.pm @@ -29,7 +29,7 @@ sub new { } sub read { - # Mbox reader, works as a iterator. + # Mbox reader, works as an iterator. # @return [String] Contents of mbox my $self = shift; return undef unless -T $self->{'handle'}; @@ -68,13 +68,13 @@ Sisimai::Mail::STDIN - Mailbox reader =head1 DESCRIPTION -Sisimai::Mail::STDIN read email data from STDIN. +C read email data from Standard-In =head1 CLASS METHODS =head2 C> -C is a constructor of Sisimai::Mail::STDIN +C method is a constructor of C my $mailbox = Sisimai::Mail::STDIN->new(); @@ -82,32 +82,32 @@ C is a constructor of Sisimai::Mail::STDIN =head2 C> -C returns "" +C metehod returns a fixed string C<""> print $mailbox->path; # "" =head2 C> -C returns the data size which has been read +C method returns the data size which has been read print $mailbox->size; # 2202 =head2 C> -C returns offset position for seeking the mbox. The value of "offset" is bytes which have -already read. +C method returns the offset position for seeking the mbox. The value of C<"offset"> is a +bytes which have already read. print $mailbox->offset; # 0 =head2 C> -C returns file handle object (IO::Handle) of the mbox. +C method returns file handle object C of the mbox. $mailbox->handle; =head2 C> -C works as a iterator for reading each email in the mbox. +C method works as an iterator for reading each email in the mbox. my $mailbox = Sisimai::Mail->new(); while( my $r = $mailbox->read ) { diff --git a/lib/Sisimai/Message.pm b/lib/Sisimai/Message.pm index 3ccf7a3d..c6eb89d4 100644 --- a/lib/Sisimai/Message.pm +++ b/lib/Sisimai/Message.pm @@ -361,7 +361,7 @@ sub sift { # @param options mail [String] from From line of mbox # @param options mail [Hash] header Email header data # @param options mail [String] rfc822 Original message part - # @param options mail [Array] ds Delivery status list(parsed data) + # @param options mail [Array] ds Delivery status list(decoded data) # @param options argvs [String] body Email message body # @param options argvs [Code] hook Hook method to be called # @return [Hash] Parsed and structured bounce mails @@ -485,7 +485,7 @@ __END__ =head1 NAME -Sisimai::Message - Convert bounce email text to data structure. +Sisimai::Message - Converts the bounce email text to the data structure. =head1 SYNOPSIS @@ -505,20 +505,20 @@ Sisimai::Message - Convert bounce email text to data structure. =head1 DESCRIPTION -Sisimai::Message convert bounce email text to data structure. It resolve email text into an UNIX From -line, the header part of the mail, delivery status, and RFC822 header part. When the email given as a -argument of "new" method is not a bounce email, the method returns "undef". +C converts the bounce email text to the data structure. It resolves the email text +into the UNIX From line, the header part of the mail, the delivery status, and RFC822 header part lines. +When the email given as a argument of C method is not a bounce email, the method returns C. =head1 CLASS METHODS =head2 C)>> -C is a constructor of Sisimai::Message +C method is a constructor of C my $mailtxt = 'Entire email text'; my $message = Sisimai::Message->rise('data' => $mailtxt); -If you have implemented a custom MTA module and use it, set the value of "load" in the argument of +If you have implemented a custom MTA module and use it, set the value of C in the argument of this method as an array reference like following code: my $message = Sisimai::Message->rise( @@ -526,56 +526,23 @@ this method as an array reference like following code: 'load' => ['Your::Custom::MTA::Module'] ); -Beginning from v4.19.0, C argument is available to callback user defined method like the -following codes: - - my $cmethod = sub { - my $argv = shift; - my $data = { - 'queue-id' => '', - 'x-mailer' => '', - 'precedence' => '', - }; - - # Header part of the bounced mail - for my $e ( 'x-mailer', 'precedence' ) { - next unless exists $argv->{'headers'}->{ $e }; - $data->{ $e } = $argv->{'headers'}->{ $e }; - } - - # Message body of the bounced email - if( $argv->{'message'} =~ /^X-Postfix-Queue-ID:\s*(.+)$/m ) { - $data->{'queue-id'} = $1; - } - - return $data; - }; - - my $message = Sisimai::Message->rise( - 'data' => $mailtxt, - 'hook' => $cmethod, - ); - print $message->catch->{'x-mailer'}; # Apple Mail (2.1283) - print $message->catch->{'queue-id'}; # 2DAEB222022E - print $message->catch->{'precedence'}; # bulk - =head1 INSTANCE METHODS =head2 C> -C returns the UNIX From line of the email. +C method returns the UNIX From line of the email. print $message->from; =head2 C> -C returns the header part of the email. +C method returns the header part of the email. print $message->header->{'subject'}; # Returned mail: see transcript for details =head2 C> -C returns an array reference which include contents of delivery status. +C method returns an array reference which include contents of the delivery status. for my $e ( $message->ds->@* ) { print $e->{'status'}; # 5.1.1 @@ -584,15 +551,15 @@ C returns an array reference which include contents of delivery status. =head2 C> -C returns a hash reference which include the header part of the original message. +C method returns a hash reference which include the header part of the original message. print $message->rfc822->{'from'}; # cat@example.com print $message->rfc822->{'to'}; # neko@example.jp =head2 C> -C returns any data generated by user-defined method passed at the `hook` argument of new() -constructor. +C method returns any data generated by user-defined method passed at the C argument +of C constructor. =head1 AUTHOR diff --git a/lib/Sisimai/Order.pm b/lib/Sisimai/Order.pm index 727bb6e6..b48cf651 100644 --- a/lib/Sisimai/Order.pm +++ b/lib/Sisimai/Order.pm @@ -202,7 +202,7 @@ __END__ =head1 NAME -Sisimai::Order - A Class for making an optimized order list for calling MTA modules in Sisimai::Lhost::*. +Sisimai::Order - A Class for making an optimized order list for calling MTA modules in C =head1 SYNOPSIS @@ -210,23 +210,23 @@ Sisimai::Order - A Class for making an optimized order list for calling MTA modu =head1 DESCRIPTION -Sisimai::Order class makes optimized order list which include MTA modules to be loaded on first from -MTA specific headers in the bounce mail headers such as X-Failed-Recipients, which MTA modules for -JSON structure. +C class makes optimized order list which include MTA modules to be loaded on first +from MTA specific headers in the bounce mail headers such as C, which MTA modules +for JSON structure. =head1 CLASS METHODS =head2 C> -C returns a default order of MTA modules as an array reference. The default order is -defined at Sisimai::Lhost->index method. +C method returns a default order of MTA modules as an array reference. The default order +is defined at Cindex()> method. print for Sisimai::Order->default->@*; =head2 C> -C returns another list of MTA modules as an array reference. Another list is defined at -this class. +C method returns another list of MTA modules as an array reference. Another list is defined +at this class. print for Sisimai::Order->another->@*; @@ -243,3 +243,4 @@ Copyright (C) 2015-2017,2019-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/RFC1894.pm b/lib/Sisimai/RFC1894.pm index 13967d6b..40f7e0e0 100644 --- a/lib/Sisimai/RFC1894.pm +++ b/lib/Sisimai/RFC1894.pm @@ -192,13 +192,13 @@ Sisimai::RFC1894 - DSN field defined in RFC3464 (obsoletes RFC1894) =head1 DESCRIPTION -Sisimai::RFC1894 provide methods for checking or getting DSN fields +C provide methods for checking or getting DSN fields =head1 CLASS METHODS =head2 C)>> -C checks the argument includes a field defined in RFC3464 or not +C method checks the argument includes the field defined in RFC3464 or not print Sisimai::RFC1894->match('From: Nyaan '); # 0 print Sisimai::RFC1894->match('Reporting-MTA: DNS; mx.libsisimai.org'); # 1 @@ -206,8 +206,8 @@ C checks the argument includes a field defined in RFC3464 or not =head2 C)>> -C returns a lower cased field name such as "diagnostic-code" from given an email header or -a delivery status field. +C method returns a lower cased field name such as C<"diagnostic-code"> from the given email +header or the delivery status field. print Sisimai::RFC1894->label('Remote-MTA: DNS; mx.nyaan.jp'); # remote-mta print Sisimai::RFC1894->field('Status: 5.1.1'); # status @@ -216,8 +216,8 @@ a delivery status field. =head2 C)>> -C returns splited values as an array reference from given a string including DSN fields -defined in RFC3464. +C method returns the splited values as an array reference from the given string including +DSN fields defined in RFC3464. my $v = Sisimai::RFC1894->field('Remote-MTA: DNS; mx.nyaan.jp'); my $r = Sisimai::RFC1894->field('Status: 5.1.1'); diff --git a/lib/Sisimai/RFC2045.pm b/lib/Sisimai/RFC2045.pm index dc32186a..2fae7709 100644 --- a/lib/Sisimai/RFC2045.pm +++ b/lib/Sisimai/RFC2045.pm @@ -373,42 +373,44 @@ Sisimai::RFC2045 - MIME Utilities =head1 DESCRIPTION -Sisimai::RFC2045 is MIME Utilities for C, is formerly known as C. +C is MIME Utilities for Sisimai, is formerly known as C. =head1 CLASS METHODS =head2 C)>> -C returns that the argument is MIME-Encoded string or not. +C method returns that the argument is a MIME-Encoded string or not. my $e = '=?utf-8?B?55m954yr44Gr44KD44KT44GT?='; my $v = Sisimai::RFC2045->is_encoded(\$e); # 1 =head2 C)>> -C is a decoder method for getting the original string from MIME-Encoded string in email -headers. +C method is a decoding method for getting the original string from the MIME-Encoded string +in the email headers. my $r = '=?utf-8?B?55m954yr44Gr44KD44KT44GT?='; my $v = Sisimai::RFC2045->decodeH([$r]); =head2 C)>> -C is a decoder method for getting the original string from MIME Base64 encoded string. +C method is a decoding method for getting the original string from the MIME Base64 encoded +string. my $r = '44Gr44KD44O844KT'; my $v = Sisimai::RFC2045->decodeB(\$r); =head2 C)>> -C is a decoder method for getting the original string from MIME quoted-printable encoded string. +C method is a decoding method for getting the original string from the MIME quoted-printable +encoded string. my $r = '=4e=65=6b=6f'; my $v = Sisimai::RFC2045->decodeQ(\$r); =head2 C, I)>> -C returns the value of parameter in Content-Type header. +C method returns the value of parameter in C header. my $r = 'Content-Type: multipart/mixed; boundary=Apple-Mail-1-526612466'; charset=utf8; print Sisimai::RFC2045->parameter($r, 'charset'); # utf8 @@ -417,7 +419,7 @@ C returns the value of parameter in Content-Type header. =head2 C, I)>> -C returns a boundary string from the value of Content-Type header. +C method returns the boundary string from the value of C header. my $r = 'Content-Type: multipart/mixed; boundary=Apple-Mail-1-526612466'; my $v = Sisimai::RFC2045->boundary($r); @@ -428,18 +430,18 @@ C returns a boundary string from the value of Content-Type header. =head2 C, I)>> -C remove unused headers from multipart/* block. +C method remove unused headers from the Cblock. =head2 C, I<\String>)>> -C breaks multipart/* message block into each part and returns an array reference. +C method breaks the C message block into each part and returns an array reference. =head2 C, I<\String>)>> -C makes flat multipart/* message: This method breaks multipart/* block into each part, remove -parts which are not needed to parse a bounce message such as image/* MIME type, and decode an encoded -text part (text/*, message/*) in a body of each part that has C header and -the value of the header is quoted-printabe, base64, or 7bit. +C method makes flat C message: This method breaks C block into +each part, remove parts which are not needed to parse the bounce message such as C MIME +type, and decode the encoded text part (C, C) in the body of each part that has +C header and the value of the header is quoted-printabe, base64, or 7bit. =head1 AUTHOR diff --git a/lib/Sisimai/RFC3464.pm b/lib/Sisimai/RFC3464.pm index 8dea84a5..96a3dc9a 100644 --- a/lib/Sisimai/RFC3464.pm +++ b/lib/Sisimai/RFC3464.pm @@ -406,7 +406,7 @@ __END__ =head1 NAME -Sisimai::RFC3464 - bounce mail parser class for Fallback. +Sisimai::RFC3464 - bounce mail decoder class for Fallback. =head1 SYNOPSIS @@ -414,21 +414,21 @@ Sisimai::RFC3464 - bounce mail parser class for Fallback. =head1 DESCRIPTION -Sisimai::RFC3464 is a class which called from called from only Sisimai::Message when other -Sisimai::Lhost::* modules did not detected a bounce reason. +C is a class which called from called from only C when other +C modules did not detected a bounce reason. =head1 CLASS METHODS =head2 C> -C returns description string of this module. +C method returns the description string of this module. print Sisimai::RFC3464->description; =head2 C, I)>> -C method parses a bounced email and return results as a array reference. See Sisimai::Message -for more details. +C method method decodes a bounced email and return results as an array reference. +See C for more details. =head1 AUTHOR @@ -443,3 +443,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/RFC3834.pm b/lib/Sisimai/RFC3834.pm index 9d799469..db5c325a 100644 --- a/lib/Sisimai/RFC3834.pm +++ b/lib/Sisimai/RFC3834.pm @@ -153,21 +153,21 @@ Sisimai::RFC3834 - RFC3834 auto reply message detector =head1 DESCRIPTION -Sisimai::RFC3834 is a class which called from called from only Sisimai::Message when other -Sisimai::Lhost::* modules did not detected a bounce reason. +C is a class which called from called from only C when other +C modules did not detected a bounce reason. =head1 CLASS METHODS =head2 C> -C returns description string of this module. +C method returns the description string of this module. print Sisimai::RFC3834->description; =head2 C, I)>> -C method parses an auto replied message and return results as an array reference. See -Sisimai::Message for more details. +C method decodes an auto replied message and return results as an array reference. See +C for more details. =head1 AUTHOR diff --git a/lib/Sisimai/RFC5322.pm b/lib/Sisimai/RFC5322.pm index 4e80afe8..fd382f71 100644 --- a/lib/Sisimai/RFC5322.pm +++ b/lib/Sisimai/RFC5322.pm @@ -263,13 +263,13 @@ Sisimai::RFC5322 - Email address related utilities =head1 DESCRIPTION -Sisimai::RFC5322 provide methods for checking email address. +C provide methods for checking an email address. =head1 CLASS METHODS =head2 C)>> -C returns array reference including elements in the Received header. +C method returns an array reference including elements in the C header. my $v = 'from mx.example.org (c1.example.org [192.0.2.1]) by neko.libsisimai.org with ESMTP id neko20180202nyaan for ; ...'; @@ -287,8 +287,8 @@ C returns array reference including elements in the Received header. =head2 C, I)>> -C returns array reference which include error message lines of given message body and the -original message part split by the 2nd argument. +C method returns an array reference which include error message lines of given message body +and the original message part splitted by the 2nd argument. my $v = 'Error message here Content-Type: message/rfc822 @@ -314,3 +314,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/RFC5965.pm b/lib/Sisimai/RFC5965.pm index dab73a4a..21d72431 100644 --- a/lib/Sisimai/RFC5965.pm +++ b/lib/Sisimai/RFC5965.pm @@ -42,7 +42,7 @@ Sisimai::RFC5965 - A class for An Extensible Format for Email Feedback Reports =head1 DESCRIPTION -Sisimai::RFC5965 provide methods related to An Extensible Format for Email Feedback Reports +C provide methods related to An Extensible Format for Email Feedback Reports =head1 AUTHOR diff --git a/lib/Sisimai/Reason.pm b/lib/Sisimai/Reason.pm index 2844eee6..2bb18d32 100644 --- a/lib/Sisimai/Reason.pm +++ b/lib/Sisimai/Reason.pm @@ -224,294 +224,32 @@ Sisimai::Reason - Detect the bounce reason =head1 DESCRIPTION -Sisimai::Reason detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method. This class is called only Sisimai::Fact class. +C detects the bounce reason from the content of C object as an argument +of C method. This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head2 C)>> -C is a method for detecting the bounce reason, it works as a fall back method of get() -and called only from get() method. +C method is a method for detecting the bounce reason, it works as a fall back method +of C and called only from C method. C detects the bounce reason from given text as a error message. =head2 C)>> -C is a method for detecting the bounce reason from the string given as an argument of the -method. However, this method is low analytical precision. +C method is a method for detecting the bounce reason from the string given as an argument +of the method. However, this method is low analytical precision. =head1 LIST OF BOUNCE REASONS -Cget()> detects the reason of bounce with parsing the bounced messages. The following -reasons will be set in the value of C property of Sisimai::Fact instance. - -=head2 C - -This is the error that SMTP connection was rejected due to a client IP address or a hostname, or the -parameter of C command. This reason has added in Sisimai 4.0.0. - - : - Connected to 192.0.2.112 but my name was rejected. - Remote host said: 501 5.0.0 Invalid domain name - -=head2 C - -This is the error that a destination mail server has rejected email due to header format of the email -like the following. Sisimai will set C to the reason of email bounce if the value of -Status: field in a bounce email -is C<5.6.*>. - -=over - -=item - 8 bit data in message header - -=item - Too many "Received" headers - -=item - Invalid MIME headers - -=back - - ... while talking to g5.example.net.: - >>> DATA - <<< 550 5.6.9 improper use of 8-bit data in message header - 554 5.0.0 Service unavailable - -=head2 C - -This is NOT AN ERROR and means the message you sent has delivered to recipients successfully. - - Final-Recipient: rfc822; kijitora@neko.nyaan.jp - Action: delivered - Status: 2.1.5 - Remote-MTA: dns; home.neko.nyaan.jp - Diagnostic-Code: SMTP; 250 2.1.5 OK - -=head2 C - -This is the error that a message was rejected due to an email exceeded the limit. The value of D.S.N. -is C<5.2.3>. This reason is almost the same as C, we think. - - ... while talking to mx.example.org.: - >>> MAIL From: SIZE=16600348 - <<< 552 5.2.3 Message size exceeds fixed maximum message size (10485760) - 554 5.0.0 Service unavailable - -=head2 C - -This is the error that delivery time has expired due to connection failure or network error and the -message you sent has been in the queue for long time. - -=head2 C - -The message you sent was forwarded to the sender as a complaint message from your mailbox provider. -When Sismai has set C to the reason, the value of C is also set like the -following parsed data. - -=head2 C - -This is the error that an email has been rejected by a header content after SMTP DATA command. In -Japanese cellular phones, the error will incur that a sender's email address or a domain is rejected -by recipient's email configuration. Sisimai will set C to the reason of email bounce if -the value of Status: field in a bounce email is C<5.2.0> or C<5.2.1>. - -This error reason is almost the same as UserUnknown. - - ... while talking to mfsmax.ntt.example.ne.jp.: - >>> DATA - <<< 550 Unknown user kijitora@ntt.example.ne.jp - 554 5.0.0 Service unavailable - -=head2 C - -This is the error that a user's mailbox has moved (and is not forwarded automatically). Sisimai will -set C to the reason of email bounce if the value of Status: field in a bounce email is C<5.1.6>. - - : host mx1.example.go.jp[192.0.2.127] said: 550 5.1.6 recipient - no longer on server: kijitora@example.go.jp (in reply to RCPT TO command) - -=head2 C - -This is the error that a domain part (Right hand side of @ sign) of a recipient's email address does -not exist. In many case, the domain part is misspelled, or the domain name has been expired. Sisimai -will set C to the reason of email bounce if the value of Status: field in a bounce mail -is C<5.1.2>. - - Your message to the following recipients cannot be delivered: - - : - <<< No such domain. - -=head2 C - -This is the error that a recipient's mailbox is full. Sisimai will set C to the reason -of email bounce if the value of Status: field in a bounce email is C<4.2.2> or C<5.2.2>. - - Action: failed - Status: 5.2.2 - Diagnostic-Code: smtp;550 5.2.2 ... Mailbox Full - -=head2 C - -This is the error that a mailer program has not exited successfully or exited unexpectedly on a -destination mail server. - - X-Actual-Recipient: X-Unix; |/home/kijitora/mail/catch.php - Diagnostic-Code: X-Unix; 255 - -=head2 C - -This is the error that a sent email size is too big for a destination mail server. In many case, -There are many attachment files with email, or the file size is too large. Sisimai will set C -to the reason of email bounce if the value of Status: field in a bounce email is C<5.3.4>. - - Action: failed - Status: 553 Exceeded maximum inbound message size - -=head2 C - -This is the error that SMTP connection failed due to DNS look up failure or other network problems. -This reason has added in Sisimai 4.1.12. - - A message is delayed for more than 10 minutes for the following - list of recipients: - - kijitora@neko.example.jp: Network error on destination MXs - -=head2 C - -This is the error that SMTP connection rejected with error message C. - - ... while talking to mailin-01.mx.example.com.: - >>> RCPT To: - <<< 554 5.7.1 : Relay access denied - 554 5.0.0 Service unavailable - -=head2 C - -This is the error that a destination mail server does ( or can ) not accept any email. In many case, -the server is high load or under the maintenance. Sisimai will set C to the reason of -email bounce if the value of Status: field in a bounce email is C<5.3.2> or the value of SMTP reply -code is 556. - -=head2 C - -Sisimai will set C to the reason of email bounce if there is no (or less) detailed information -about email bounce for judging the reason. - -=head2 C - -This is the error that a policy violation was detected on a destination mail server. This reason has -been divided from C at Sisimai 4.22.0. - - 570 5.7.7 Email not accepted for policy reasons - -=head2 C - -This is the error that a connection to destination server was rejected by a sender's email address -(envelope from). Sisimai set C to the reason of email bounce if the value of Status: field -in a bounce email is C<5.1.8> or the connection has been rejected due to the argument of SMTP MAIL -command. - - : - Connected to 192.0.2.225 but sender was rejected. - Remote host said: 550 5.7.1 ... Access denied - -=head2 C - -This is the error that a security violation was detected on a destination mail server. Depends on the -security policy on the server, a sender's email address is camouflaged address. Sisimai will set -C to the reason of email bounce if the value of Status: field in a bounce email is C<5.7.*>. - - Status: 5.7.0 - Remote-MTA: DNS; gmail-smtp-in.l.google.com - Diagnostic-Code: SMTP; 552-5.7.0 Our system detected an illegal attachment on your message. Please - -=head2 C - -This is the error that the message you sent was rejected by C filter which is running on the -remote host. This reason has added in Sisimai 4.1.25. - - Action: failed - Status: 5.7.1 - Diagnostic-Code: smtp; 550 5.7.1 Message content rejected, UBE, id=00000-00-000 - Last-Attempt-Date: Thu, 9 Apr 2008 23:34:45 +0900 (JST) - -=head2 C - -This is the error that a recipient account is being suspended due to unpaid or other reasons. - -=head2 C - -This is the error that a destination mail server could not recognize SMTP command which is sent from -a sender's MTA. This reason has been added at Sisimai v4.17.0. - -=over - -=item - 503 Improper sequence of commands - -=item - 504 Command parameter not implemented - -=back - -=head2 C - -This is the error that an email has bounced due to system error on the remote host such as LDAP -connection failure or other internal system error. - - : - Unable to contact LDAP server. (#4.4.3)I'm not going to try again; this - message has been in the queue too long. - -=head2 C - -This is the error that a destination mail server's disk (or spool) is full. Sisimai will set C -to the reason of email bounce if the value of Status: field in a bounce email is C<4.3.1> or C<5.3.1>. - -=head2 C - -This is the error that SMTP connection was rejected temporarily due to too many concurrency connections -to the remote server. This reason has added in Sisimai 4.1.26. - - : host mx02.example.ne.jp[192.0.1.20] said: - 452 4.3.2 Connection rate limit exceeded. (in reply to MAIL FROM command) - -=head2 C - -This is the error that a local part (Left hand side of @ sign) of a recipient's email address does -not exist. In many case, a user has changed internet service provider, or has quit company, or the -local part is misspelled. Sisimai will set C to the reason of email bounce if the value -of Status: field in a bounce email is C<5.1.1>, or connection was refused at SMTP RCPT command, or -the contents of Diagnostic-Code: field represents that it is unknown user. - - : host mx01.example.co.jp[192.0.2.8] said: - 550 5.1.1 Address rejected kijitora@example.co.jp (in reply to - RCPT TO command) - -=head2 C - -Sisimai could not detect the error reason. In many case, error message is written in non-English or -there are no enough error message in a bounce email to decide the reason. - -=head2 C - -This is the reason that the recipient is out of office. The bounce message is generated and returned -from auto responder program. This reason has added in Sisimai 4.1.28 - -=head2 C - -This is the error that an email was rejected by a virus scanner at a destination mail server. This -reason has been divided from C at Sisimai 4.22. - - Your message was infected with a virus. You should download a virus - scanner and check your computer for viruses. - - Sender: - Recipient: +Cget()> method detects the reason of bounce with decoding the bounced messages. +The following reasons will be set in the value of C property of C instance. +The list of all the bounce reasons is available at L. =head1 SEE ALSO diff --git a/lib/Sisimai/Reason/AuthFailure.pm b/lib/Sisimai/Reason/AuthFailure.pm index ef6ec664..597028f3 100644 --- a/lib/Sisimai/Reason/AuthFailure.pm +++ b/lib/Sisimai/Reason/AuthFailure.pm @@ -67,8 +67,8 @@ Sisimai::Reason::AuthFailure - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::AuthFailure checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is +called only C class. This is the error that an authenticaion failure related to SPF, DKIM, or DMARC was detected on a destination mail host. @@ -82,20 +82,20 @@ destination mail host. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::AuthFailure->text; # authfailure =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::AuthFailure->match('5.7.0 SPF Check: fail'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact -object and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/BadReputation.pm b/lib/Sisimai/Reason/BadReputation.pm index 3bd10a31..2db518c5 100644 --- a/lib/Sisimai/Reason/BadReputation.pm +++ b/lib/Sisimai/Reason/BadReputation.pm @@ -56,8 +56,8 @@ Sisimai::Reason::BadReputation - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::BadReputation checks the bounce reason is C or not. This class is -called only Sisimai::Reason class. +C checks the bounce reason is C or not. This class +is called only C class. This is the error that an email rejected due to a reputation score of the sender IP address. @@ -74,20 +74,20 @@ This is the error that an email rejected due to a reputation score of the sender =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::BadReputation->text; # badreputation =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::BadReputation->match('low reputation of the sending IP'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact -object and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/Blocked.pm b/lib/Sisimai/Reason/Blocked.pm index ee308530..dbbcf0ae 100644 --- a/lib/Sisimai/Reason/Blocked.pm +++ b/lib/Sisimai/Reason/Blocked.pm @@ -140,11 +140,11 @@ Sisimai::Reason::Blocked - Bounce reason is "blocked" or not. =head1 DESCRIPTION -Sisimai::Reason::Blocked checks the bounce reason is "blocked" or not. This class is called only -Sisimai::Reason class. +C checks the bounce reason is C or not. This class is called +only C class. This is the error that SMTP connection was rejected due to a client IP address or a hostname, or -the parameter of "HELO/EHLO" command. This reason has added in Sisimai 4.0.0. +the parameter of C or C command. This reason has added in Sisimai 4.0.0. : Connected to 192.0.2.112 but my name was rejected. @@ -154,20 +154,20 @@ the parameter of "HELO/EHLO" command. This reason has added in Sisimai 4.0.0. =head2 C> -C returns string: "blocked". +C method returns the fixed string C. print Sisimai::Reason::Blocked->text; # blocked =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::Blocked->match('Access from ip address 192.0.2.1 blocked'); # 1 =head2 C)>> -C returns 1 if the bounce reason is "blocked". The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR @@ -182,3 +182,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/ContentError.pm b/lib/Sisimai/Reason/ContentError.pm index 8f7997eb..8a2d16fb 100644 --- a/lib/Sisimai/Reason/ContentError.pm +++ b/lib/Sisimai/Reason/ContentError.pm @@ -54,18 +54,18 @@ Sisimai::Reason::ContentError - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::ContentError checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is +called only C class. -This is the error that a destination mail server has rejected email due to header format of the email -like the following. Sisimai will set C to the reason of email bounce if the value of -Status: field in a bounce email is "5.6.*". +This is the error that the destination mail server has rejected email due to the header format of +the email like the following. Sisimai will set C to the reason of the email bounce if +the value of C field in a bounce email is C<5.6.*>. =over =item - 8 bit data in message header -=item - Too many "Received" headers +=item - Too many C headers =item - Invalid MIME headers @@ -80,20 +80,20 @@ Status: field in a bounce email is "5.6.*". =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::ContentError->text; # contenterror =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::ContentError->match('550 Message Filterd'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/Delivered.pm b/lib/Sisimai/Reason/Delivered.pm index a08fd842..0fd0da65 100644 --- a/lib/Sisimai/Reason/Delivered.pm +++ b/lib/Sisimai/Reason/Delivered.pm @@ -24,32 +24,32 @@ Sisimai::Reason::Delivered - Email delivered successfully =head1 DESCRIPTION -Sisimai::Reason::Delivered checks the email you sent is delivered successfully or not by matching -diagnostic messages with message patterns. Sisimai will set "delivered" to the value of "reason" -when Status: field in the bounce message begins with "2" like following: +C checks the email you sent is delivered successfully or not by matching +diagnostic messages with message patterns. Sisimai will set C<"delivered"> to the value of C<"reason"> +when C field in the bounce message begins with C<2> like following: Final-Recipient: rfc822; kijitora@neko.nyaan.jp Action: delivered Status: 2.1.5 Diagnostic-Code: SMTP; 250 2.1.5 OK -This class is called only Sisimai->reason method. This is NOT AN ERROR reason. +This class is called only Creason()> method. This is B reason. =head1 CLASS METHODS =head2 C> -C returns string: C. +C returns the fixed string C. print Sisimai::Reason::Delivered->text; # delivered =head2 C)>> -C always return undef +C method always return C =head2 C)>> -C always return undef +C method always return C =head1 AUTHOR @@ -64,3 +64,4 @@ Copyright (C) 2016,2020,2021,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/ExceedLimit.pm b/lib/Sisimai/Reason/ExceedLimit.pm index 8c6ef5a9..3386e234 100644 --- a/lib/Sisimai/Reason/ExceedLimit.pm +++ b/lib/Sisimai/Reason/ExceedLimit.pm @@ -61,11 +61,11 @@ Sisimai::Reason::ExceedLimit - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::ExceedLimit checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is +called only C class. -This is the error that a message was rejected due to an email exceeded the limit. The value of D.S.N. -is 5.2.3. This reason is almost the same as C, we think. +This is the error that a message was rejected due to an email exceeded the limit. The value of DSN +is C<5.2.3>. This reason is almost the same as C, we think. ... while talking to mx.example.org.: >>> MAIL From: SIZE=16600348 @@ -76,20 +76,20 @@ is 5.2.3. This reason is almost the same as C, we think. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::ExceedLimit->text; # exceedlimit =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::ExceedLimit->match; # 0; =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 SEE ALSO @@ -112,3 +112,4 @@ Copyright (C) 2014-2016,2018,2020,2021,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/Expired.pm b/lib/Sisimai/Reason/Expired.pm index d3ca2824..9603cd57 100644 --- a/lib/Sisimai/Reason/Expired.pm +++ b/lib/Sisimai/Reason/Expired.pm @@ -71,30 +71,30 @@ Sisimai::Reason::Expired - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::Expired checks the bounce reason is C or not. This class is called only -Sisimai::Reason class. +C checks the bounce reason is C or not. This class is called only +C class. -This is the error that delivery time has expired due to connection failure or network error and the -message you sent has been in the queue for long time. +This is the error that the delivery time has expired due to a connection failure or a network error +and the message you sent has been in the queue for long time. =head1 CLASS METHODS =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::Expired->text; # expired =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::Expired->match('400 Delivery time expired'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/Feedback.pm b/lib/Sisimai/Reason/Feedback.pm index f6d1374c..71488636 100644 --- a/lib/Sisimai/Reason/Feedback.pm +++ b/lib/Sisimai/Reason/Feedback.pm @@ -24,24 +24,24 @@ Sisimai::Reason::Feedback - Email forwarded as a complaint message =head1 DESCRIPTION -Sisimai::Reason::Feedback is for only returning text and description. This class is called only -from Sisimai->reason method and Sisimai::ARF class. +C is for only returning the text and the description. This class is called +only from Creason()> method and C class. =head1 CLASS METHODS =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::Feedback->text; # feedback =head2 C)>> -C always return undef +C method always return C =head2 C)>> -C always return undef +C method always return C =head1 AUTHOR diff --git a/lib/Sisimai/Reason/Filtered.pm b/lib/Sisimai/Reason/Filtered.pm index d075697c..11e572ca 100644 --- a/lib/Sisimai/Reason/Filtered.pm +++ b/lib/Sisimai/Reason/Filtered.pm @@ -85,15 +85,15 @@ Sisimai::Reason::Filtered - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::Filtered checks the bounce reason is C or not. This class is called only -Sisimai::Reason class. +C checks the bounce reason is C or not. This class is called +only C class. -This is the error that an email has been rejected by a header content after SMTP DATA command. In -Japanese cellular phones, the error will incur that a sender's email address or a domain is rejected -by recipient's email configuration. Sisimai will set C to the reason of email bounce if -the value of Status: field in a bounce email is C<5.2.0> or C<5.2.1>. +This is the error that an email has been rejected by a header content after SMTP C command. +In Japanese cellular phones, the error will incur that the sender's email address or the domain is +rejected by recipient's email configuration. Sisimai will set C to the reason of email +bounce if the value of C field in the bounce email is C<5.2.0> or C<5.2.1>. -This error reason is almost the same as UserUnknown. +This error reason is almost the same as C. ... while talking to mfsmax.ntt.example.ne.jp.: >>> DATA @@ -104,20 +104,20 @@ This error reason is almost the same as UserUnknown. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::Filtered->text; # filtered =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::Filtered->match('550 5.1.2 User reject'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from Sisimai::Reason class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/HasMoved.pm b/lib/Sisimai/Reason/HasMoved.pm index bd97abb0..f1ae4e1a 100644 --- a/lib/Sisimai/Reason/HasMoved.pm +++ b/lib/Sisimai/Reason/HasMoved.pm @@ -50,11 +50,12 @@ Sisimai::Reason::HasMoved - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::HasMoved checks the bounce reason is C or not. This class is called only -Sisimai::Reason class. +C checks the bounce reason is C or not. This class is called +only C class. -This is the error that a user's mailbox has moved (and is not forwarded automatically). Sisimai will -set C to the reason of email bounce if the value of Status: field in a bounce email is C<5.1.6>. +This is the error that the user's mailbox has moved (and is not forwarded automatically). Sisimai +will set C to the reason of the email bounce if the value of the C field in the +bounce email is C<5.1.6>. : host mx1.example.go.jp[192.0.2.127] said: 550 5.1.6 recipient no longer on server: kijitora@example.go.jp (in reply to RCPT TO command) @@ -63,20 +64,20 @@ set C to the reason of email bounce if the value of Status: field in a =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::HasMoved->text; # hasmoved =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::HasMoved->match('address cat@example.jp has been replaced by '); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR @@ -91,3 +92,4 @@ Copyright (C) 2015-2016,2018,2020,2021,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/HostUnknown.pm b/lib/Sisimai/Reason/HostUnknown.pm index bdad0d2e..8915db0f 100644 --- a/lib/Sisimai/Reason/HostUnknown.pm +++ b/lib/Sisimai/Reason/HostUnknown.pm @@ -82,13 +82,13 @@ Sisimai::Reason::HostUnknown - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::HostUnknown checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is +called only C class. -This is the error that a domain part (Right hand side of @ sign) of a recipient's email address does -not exist. In many case, the domain part is misspelled, or the domain name has been expired. Sisimai -will set C to the reason of email bounce if the value of Status: field in a bounce mail -is C<5.1.2>. +This is the error that the domain part (Right hand side of C<@> sign) of the recipient's email address +does not exist. In many case, the domain part is misspelled, or the domain name has been expired. +Sisimai will set C to the reason of the email bounce if the value of C field +in a bounce mail is C<5.1.2>. Your message to the following recipients cannot be delivered: @@ -99,20 +99,20 @@ is C<5.1.2>. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::HostUnknown->text; # hostunknown =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::HostUnknown->match('550 5.2.1 Host Unknown'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR @@ -127,3 +127,4 @@ Copyright (C) 2014-2018,2020,2021,2023,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/MailboxFull.pm b/lib/Sisimai/Reason/MailboxFull.pm index 3c94697e..958767cb 100644 --- a/lib/Sisimai/Reason/MailboxFull.pm +++ b/lib/Sisimai/Reason/MailboxFull.pm @@ -107,11 +107,11 @@ Sisimai::Reason::MailboxFull - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::MailboxFull checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is +called only C class. -This is the error that a recipient's mailbox is full. Sisimai will set C to the reason -of email bounce if the value of Status: field in a bounce email is C<4.2.2> or C<5.2.2>. +This is the error that the recipient's mailbox is full. Sisimai will set C to the reason +of the email bounce if the value of C field in a bounce email is C<4.2.2> or C<5.2.2>. Action: failed Status: 5.2.2 @@ -121,20 +121,20 @@ of email bounce if the value of Status: field in a bounce email is C<4.2.2> or C =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::MailboxFull->text; # mailboxfull =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::MailboxFull->match('400 4.2.3 Mailbox full'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/MailerError.pm b/lib/Sisimai/Reason/MailerError.pm index 84a417d5..34739da9 100644 --- a/lib/Sisimai/Reason/MailerError.pm +++ b/lib/Sisimai/Reason/MailerError.pm @@ -57,10 +57,10 @@ Sisimai::Reason::MailerError - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::MailerError checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is +called only C class. -This is the error that a mailer program has not exited successfully or exited unexpectedly on a +This is the error that the mailer program has not exited successfully or exited unexpectedly on the destination mail server. X-Actual-Recipient: X-Unix; |/home/kijitora/mail/catch.php @@ -70,20 +70,20 @@ destination mail server. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::MailerError->text; # mailererror =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::MailerError->match('X-Unix; 255'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR @@ -98,3 +98,4 @@ Copyright (C) 2014-2017,2020,2021,2023,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/MesgTooBig.pm b/lib/Sisimai/Reason/MesgTooBig.pm index b2bd7725..ebf363fc 100644 --- a/lib/Sisimai/Reason/MesgTooBig.pm +++ b/lib/Sisimai/Reason/MesgTooBig.pm @@ -73,12 +73,13 @@ Sisimai::Reason::MesgTooBig - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::MesgTooBig checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is +called only C class. -This is the error that a sent email size is too big for a destination mail server. In many case, -There are many attachment files with email, or the file size is too large. Sisimai will set C -to the reason of email bounce if the value of Status: field in a bounce email is C<5.3.4>. +This is the error that the sent email size is too big for the destination mail server. In many case, +There are many attachment files with the email, or the file size is too large. Sisimai will set +C to the reason of the email bounce if the value of C field in the bounce email +is C<5.3.4>. Action: failed Status: 553 Exceeded maximum inbound message size @@ -87,20 +88,20 @@ to the reason of email bounce if the value of Status: field in a bounce email is =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::MesgTooBig->text; # mesgtoobig =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::MesgTooBig->match('400 Message too big'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 SEE ALSO diff --git a/lib/Sisimai/Reason/NetworkError.pm b/lib/Sisimai/Reason/NetworkError.pm index e29c23f4..41af729b 100644 --- a/lib/Sisimai/Reason/NetworkError.pm +++ b/lib/Sisimai/Reason/NetworkError.pm @@ -61,10 +61,10 @@ Sisimai::Reason::NetworkError - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::NetworkError checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is +called only C class. -This is the error that SMTP connection failed due to DNS look up failure or other network problems. +This is the error that the SMTP connection failed due to DNS look up failure or other network problems. This reason has added in Sisimai 4.1.12. A message is delayed for more than 10 minutes for the following @@ -76,20 +76,20 @@ This reason has added in Sisimai 4.1.12. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::NetworkError->text; # networkerror =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::NetworkError->match('5.3.5 System config error'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact -object and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/NoRelaying.pm b/lib/Sisimai/Reason/NoRelaying.pm index 8e6ef5b9..9988393e 100644 --- a/lib/Sisimai/Reason/NoRelaying.pm +++ b/lib/Sisimai/Reason/NoRelaying.pm @@ -77,9 +77,9 @@ Sisimai::Reason::NoRelaying - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::NoRelaying checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. This is the error that SMTP connection rejected with error message -C. +C checks the bounce reason is C or not. This class is called +only C class. This is the error that the SMTP connection rejected with an error message +like C. ... while talking to mailin-01.mx.example.com.: >>> RCPT To: @@ -90,20 +90,20 @@ C. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::NoRelaying->text; # norelaying =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::NoRelaying->match('Relaying denied'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR @@ -118,3 +118,4 @@ Copyright (C) 2014-2018,2020-2023,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/NotAccept.pm b/lib/Sisimai/Reason/NotAccept.pm index 66877b2e..760eb622 100644 --- a/lib/Sisimai/Reason/NotAccept.pm +++ b/lib/Sisimai/Reason/NotAccept.pm @@ -64,32 +64,32 @@ Sisimai::Reason::NotAccept - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::NotAccept checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is called +only C class. -This is the error that a destination mail server does ( or can ) not accept any email. In many case, -the server is high load or under the maintenance. Sisimai will set C to the reason of -email bounce if the value of Status: field in a bounce email is C<5.3.2> or the value of SMTP reply -code is 556. +This is the error that the destination mail server does (or can) not accept any email. In many case, +the server is high load or under the maintenance. Sisimai will set C to the reason of the +email bounce if the value of C field in the bounce email is C<5.3.2> or the value of SMTP +reply code is C<556>. =head1 CLASS METHODS =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::NotAccept->text; # notaccept =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::NotAccept->match('domain does not exist:'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR @@ -104,3 +104,4 @@ Copyright (C) 2014-2016,2018,2020-2023,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/NotCompliantRFC.pm b/lib/Sisimai/Reason/NotCompliantRFC.pm index d14155ad..209e90ba 100644 --- a/lib/Sisimai/Reason/NotCompliantRFC.pm +++ b/lib/Sisimai/Reason/NotCompliantRFC.pm @@ -53,10 +53,10 @@ Sisimai::Reason::NotCompliantRFC - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::NotCompliantRFC checks the bounce reason is C or not. This class -is called only from Sisimai::Reason class. +C checks the bounce reason is C or not. +This class is called only from C. -This is the error that an email is not compliant RFC 5322 or other email related RFCs. For example, +This is the error that the email is not compliant RFC 5322 or other email related RFCs. For example, there are multiple C headers in the email. host aspmx.l.google.com[142.251.170.26] said: This message is not RFC 5322 compliant. There are @@ -68,20 +68,20 @@ there are multiple C headers in the email. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::NotCompliantRFC->text; # notcompliantrfc =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::NotCompliantRFC->match('This message is not RFC 5322 compliant'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact -object and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be +C object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/OnHold.pm b/lib/Sisimai/Reason/OnHold.pm index 24eaa440..e92c76e8 100644 --- a/lib/Sisimai/Reason/OnHold.pm +++ b/lib/Sisimai/Reason/OnHold.pm @@ -46,28 +46,28 @@ Sisimai::Reason::OnHold - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::OnHold checks the bounce reason is C or not. This class is called only -Sisimai::Reason class. Sisimai will set C to the reason of email bounce if there is no (or -less) detailed information about email bounce for judging the reason. +C checks the bounce reason is C or not. This class is called only +C class. Sisimai will set C to the reason of email bounce if there is no +(or less) detailed information about email bounce for judging the reason. =head1 CLASS METHODS =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::OnHold->text; # onhold =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::OnHold->match; # 0; =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR @@ -82,3 +82,4 @@ Copyright (C) 2014-2016,2018,2020,2021,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/PolicyViolation.pm b/lib/Sisimai/Reason/PolicyViolation.pm index 14f65e74..ce703952 100644 --- a/lib/Sisimai/Reason/PolicyViolation.pm +++ b/lib/Sisimai/Reason/PolicyViolation.pm @@ -74,12 +74,12 @@ Sisimai::Reason::PolicyViolation - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::PolicyViolation checks the bounce reason is C or not. This class -is called only Sisimai::Reason class. +C checks the bounce reason is C or not. +This class is called only C class. -This is the error that a policy violation was detected on a destination mail host. When a header -content or a format of the original message violates security policies, or multiple addresses exist -in the From: header, Sisimai will set C. +This is the error that a policy violation was detected on the destination mail host. When the header +content or the format of the original message violates their security policies, or multiple addresses +exist in the C header, Sisimai will set C. Action: failed Status: 5.7.0 @@ -91,20 +91,20 @@ in the From: header, Sisimai will set C. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::PolicyViolation->text; # policyviolation =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::PolicyViolation->match('5.7.9 Header error'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact -object and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be + object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/Rejected.pm b/lib/Sisimai/Reason/Rejected.pm index a1897cfb..8a7cc941 100644 --- a/lib/Sisimai/Reason/Rejected.pm +++ b/lib/Sisimai/Reason/Rejected.pm @@ -133,13 +133,13 @@ Sisimai::Reason::Rejected - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::Rejected checks the bounce reason is C or not. This class is called only -Sisimai::Reason class. +C checks the bounce reason is C or not. This class is called +only C class. -This is the error that a connection to destination server was rejected by a sender's email address -(envelope from). Sisimai set C to the reason of email bounce if the value of Status: field -in a bounce email is C<5.1.8> or the connection has been rejected due to the argument of SMTP MAIL -command. +This is the error that the SMTP connection to the destination server was rejected by the sender's +email address (envelope from). Sisimai set C to the reason of the email bounce if the value +of C field in the bounce email is C<5.1.8> or the SMTP connection has been rejected due to +the argument of SMTP C command. : Connected to 192.0.2.225 but sender was rejected. @@ -149,20 +149,20 @@ command. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::Rejected->text; # rejected =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::Rejected->match('550 Address rejected'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/RequirePTR.pm b/lib/Sisimai/Reason/RequirePTR.pm index bdbd5b97..60232574 100644 --- a/lib/Sisimai/Reason/RequirePTR.pm +++ b/lib/Sisimai/Reason/RequirePTR.pm @@ -54,7 +54,7 @@ sub true { # @return [Integer] 1: is missing PTR or invalid PTR # [Integer] 0: is not blocked due to missing PTR record # @see http://www.ietf.org/rfc/rfc2822.txt - # @since v4.0.0 + # @since v5.0.0 my $class = shift; my $argvs = shift // return undef; @@ -80,11 +80,11 @@ Sisimai::Reason::RequirePTR - Bounce reason is "requireptr" or not. =head1 DESCRIPTION -Sisimai::Reason::RequirePTR checks the bounce reason is "requireptr" or not. This class is called -only from Sisimai::Reason class. +C checks the bounce reason is C or not. This class is called +only from C class. -This is the error that SMTP connection was rejected due to missing PTR record or having invalid PTR -record at the source IP address used for the SMTP connection. +This is the error that the SMTP connection was rejected due to missing PTR record or having invalid +PTR record at the source IP address used for the SMTP connection. host gmail-smtp-in.l.google.com[142.251.170.27] said: [192.0.2.25] The IP address sending this message does not have a PTR record setup, or the @@ -96,18 +96,18 @@ record at the source IP address used for the SMTP connection. =head2 C> -C returns string: "requireptr". +C method returns the fixed string C. print Sisimai::Reason::RequirePTR->text; # "requireptr" -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::RequirePTR->match('Reverse DNS failed'); # 1 =head2 C)>> -C returns 1 if the bounce reason is "requireptr". The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/SecurityError.pm b/lib/Sisimai/Reason/SecurityError.pm index 0dd87a11..071656ed 100644 --- a/lib/Sisimai/Reason/SecurityError.pm +++ b/lib/Sisimai/Reason/SecurityError.pm @@ -69,13 +69,13 @@ Sisimai::Reason::SecurityError - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::SecurityError checks the bounce reason is C or not. This class is -called only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is +called only C class. -This is the error that a security violation was detected on a destination mail server. Depends on -the security policy on the server, a sender's email address is camouflaged address. Sisimai will -set C to the reason of email bounce if the value of Status: field in a bounce email -is C<5.7.*>. +This is the error that the security violation was detected on the destination mail server. Depends +on the security policy on the server, the sender's email address is camouflaged address. +Sisimai will set C to the reason of the email bounce if the value of C field +in the bounce email is C<5.7.*>. Action: failed Status: 5.7.1 @@ -87,20 +87,20 @@ is C<5.7.*>. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::SecurityError->text; # securityerror =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::SecurityError->match('570 5.7.0 Authentication failure'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact -object and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be +C object and this method is called only from C class. =head1 AUTHOR @@ -115,3 +115,4 @@ Copyright (C) 2014-2018,2020,2021,2023,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/SpamDetected.pm b/lib/Sisimai/Reason/SpamDetected.pm index ac2c76b1..daa83638 100644 --- a/lib/Sisimai/Reason/SpamDetected.pm +++ b/lib/Sisimai/Reason/SpamDetected.pm @@ -165,10 +165,10 @@ or not. =head1 DESCRIPTION -Sisimai::Reason::SpamDetected checks the bounce reason is C due to Spam content in the -message or not. This class is called only Sisimai::Reason class. +C checks the bounce reason is C due to the spam content +in the message or not. This class is called only C class. -This is the error that the message you sent was rejected by C filter which is running on the +This is the error that the message you sent was rejected by the spam filter which is running on the remote host. This reason has added in Sisimai 4.1.25. Action: failed @@ -180,20 +180,20 @@ remote host. This reason has added in Sisimai 4.1.25. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::SpamDetected->text; # spamdetected =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::SpamDetected->match('550 Spam detected'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C due to Spam content in the message. The -argument must be Sisimai::Fact object and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C due to the spam content in the message. +The argument must be C object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/Speeding.pm b/lib/Sisimai/Reason/Speeding.pm index be2e1320..52bcb09f 100644 --- a/lib/Sisimai/Reason/Speeding.pm +++ b/lib/Sisimai/Reason/Speeding.pm @@ -59,29 +59,29 @@ Sisimai::Reason::Speeding - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::Speeding checks the bounce reason is C or not. This class is called only -Sisimai::Reason class. This is the error that a connection rejected due to exceeding a rate limit -or sending too fast. +C checks the bounce reason is C or not. This class is called +only C class. This is the error that the SMTP connection rejected due to exceeding +a rate limit or sending too fast. =head1 CLASS METHODS =head2 C> -C returns string: C. +C method returns the fiexed string C. print Sisimai::Reason::Speeding->text; # speeding =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. my $v = '451 4.7.1 : Client host rejected: Please try again slower'; print Sisimai::Reason::Speeding->match($v); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/Suspend.pm b/lib/Sisimai/Reason/Suspend.pm index de9a1111..d7754888 100644 --- a/lib/Sisimai/Reason/Suspend.pm +++ b/lib/Sisimai/Reason/Suspend.pm @@ -76,28 +76,28 @@ Sisimai::Reason::Suspend - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::Suspend checks the bounce reason is C or not. This class is called only -Sisimai::Reason class. This is the error that a recipient account is being suspended due to unpaid -or other reasons. +C checks the bounce reason is C or not. This class is called only +C class. This is the error that the recipient account is being suspended due to +unpaid, or being inactive, or other reasons. =head1 CLASS METHODS =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::Suspend->text; # suspend =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::Suspend->match('recipient suspend the service'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/SyntaxError.pm b/lib/Sisimai/Reason/SyntaxError.pm index f6f97d93..a405a10c 100644 --- a/lib/Sisimai/Reason/SyntaxError.pm +++ b/lib/Sisimai/Reason/SyntaxError.pm @@ -39,12 +39,12 @@ Sisimai::Reason::SyntaxError - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::SyntaxError checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is +called only C class. -This is the error that a destination mail server could not recognize SMTP command which is sent from -a sender's MTA. Sisimai will set C to the reason if the value of C begins -with "50" such as 502, or 503. +This is the error that the destination mail server could not recognize the SMTP command which is sent +from the sender's MTA. Sisimai will set C to the reason if the value of C +begins with C<50> such as C<502>, or C<503>. Action: failed Status: 5.5.0 @@ -54,18 +54,18 @@ with "50" such as 502, or 503. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::SyntaxError->text; # syntaxerror =head2 C)>> -C always return undef +C method always return C =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be +C object and this method is called only from C class. =head1 AUTHOR @@ -80,3 +80,4 @@ Copyright (C) 2015-2016,2018,2020,2021,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/SystemError.pm b/lib/Sisimai/Reason/SystemError.pm index a84b206f..3c7e42d5 100644 --- a/lib/Sisimai/Reason/SystemError.pm +++ b/lib/Sisimai/Reason/SystemError.pm @@ -67,9 +67,9 @@ Sisimai::Reason::SystemError - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::SystemError checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. This is the error that an email has bounced due to system error on the -remote host such as LDAP connection failure or other internal system error. +C checks the bounce reason is C or not. This class is +called only C class. This is the error that the email has bounced due to system +error on the remote host such as LDAP connection failures or other internal system errors. : Unable to contact LDAP server. (#4.4.3)I'm not going to try again; this @@ -79,20 +79,20 @@ remote host such as LDAP connection failure or other internal system error. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::SystemError->text; # systemerror =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::SystemError->match('5.3.5 System config error'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be +C object and this method is called only from C class. =head1 AUTHOR diff --git a/lib/Sisimai/Reason/SystemFull.pm b/lib/Sisimai/Reason/SystemFull.pm index 9c95ec26..3b0e0b8d 100644 --- a/lib/Sisimai/Reason/SystemFull.pm +++ b/lib/Sisimai/Reason/SystemFull.pm @@ -47,30 +47,31 @@ Sisimai::Reason::SystemFull - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::SystemFull checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is called +only C class. -This is the error that a destination mail server's disk (or spool) is full. Sisimai will set C -to the reason of email bounce if the value of Status: field in a bounce email is C<4.3.1> or C<5.3.1>. +This is the error that the destination mail server's storage (or spool) is full. Sisimai will set +C to the reason of email bounce if the value of C field in a bounce email is +C<4.3.1> or C<5.3.1>. =head1 CLASS METHODS =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::SystemFull->text; # systemfull =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::SystemFull->match('Mail System Full'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact object -and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be C +object and this method is called only from C class. =head1 AUTHOR @@ -85,3 +86,4 @@ Copyright (C) 2014-2016,2018,2020,2021,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/TooManyConn.pm b/lib/Sisimai/Reason/TooManyConn.pm index ee6eeb42..59bc609f 100644 --- a/lib/Sisimai/Reason/TooManyConn.pm +++ b/lib/Sisimai/Reason/TooManyConn.pm @@ -66,11 +66,11 @@ Sisimai::Reason::TooManyConn - Bounced due to that too many connections. =head1 DESCRIPTION -Sisimai::Reason::TooManyConn checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. This class is +called only C class. -This is the error that SMTP connection was rejected temporarily due to too many concurrency connections -to the remote server. This reason has added in Sisimai 4.1.26. +This is the error that the SMTP connection was rejected temporarily due to too many concurrency +connections to the remote server. This reason has added in Sisimai 4.1.26. : host mx02.example.ne.jp[192.0.1.20] said: 452 4.3.2 Connection rate limit exceeded. (in reply to MAIL FROM command) @@ -79,20 +79,20 @@ to the remote server. This reason has added in Sisimai 4.1.26. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::TooManyConn->text; # toomanyconn =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::TooManyConn->match('Connection rate limit exceeded'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact -object and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be +C object and this method is called only from C class. =head1 AUTHOR @@ -108,4 +108,3 @@ This software is distributed under The BSD 2-Clause License. =cut - diff --git a/lib/Sisimai/Reason/Undefined.pm b/lib/Sisimai/Reason/Undefined.pm index 5a330cf7..a65661aa 100644 --- a/lib/Sisimai/Reason/Undefined.pm +++ b/lib/Sisimai/Reason/Undefined.pm @@ -24,24 +24,24 @@ Sisimai::Reason::Undefined - Sisimai could not detect the error reason. =head1 DESCRIPTION -Sisimai::Reason::Undefined is for only returning text and description. This class is called only -from Sisimai->reason method. +C is for only returning the text and the description. +This class is called only from Creason()> method. =head1 CLASS METHODS =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::Undefined->text; # undefined =head2 C)>> -C always return undef +C method always return C =head2 C)>> -C always return undef +C method always return C =head1 AUTHOR @@ -56,3 +56,4 @@ Copyright (C) 2016,2020,2021,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/UserUnknown.pm b/lib/Sisimai/Reason/UserUnknown.pm index 51206539..897e6f54 100644 --- a/lib/Sisimai/Reason/UserUnknown.pm +++ b/lib/Sisimai/Reason/UserUnknown.pm @@ -201,14 +201,14 @@ Sisimai::Reason::UserUnknown - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::UserUnknown checks the bounce reason is C or not. This class is called -only Sisimai::Reason class. +C checks the bounce reason is C or not. +This class is called only C class. -This is the error that a local part (Left hand side of @ sign) of a recipient's email address does -not exist. In many case, a user has changed internet service provider, or has quit company, or the -local part is misspelled. Sisimai will set C to the reason of email bounce if the value -of Status: field in a bounce email is C<5.1.1>, or connection was refused at SMTP RCPT command, or -the contents of Diagnostic-Code: field represents that it is unknown user. +This is the error that the local part (left hand side of C<@> sign) of the recipient's email address +does not exist. In many case, the user has changed the internet service provider, or has quit company, +or the local part is misspelled. Sisimai will set C to the reason of the email bounce +if the value of C field in the bounce email is C<5.1.1>, or the connection was refused at +SMTP C command, or the contents of C field represents that it is unknown user. : host mx01.example.co.jp[192.0.2.8] said: 550 5.1.1 Address rejected kijitora@example.co.jp (in reply to @@ -218,20 +218,20 @@ the contents of Diagnostic-Code: field represents that it is unknown user. =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::UserUnknown->text; # userunknown =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. print Sisimai::Reason::UserUnknown->match('550 5.1.1 Unknown User'); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact -object and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be +C object and this method is called only from C class. =head1 AUTHOR @@ -246,3 +246,4 @@ Copyright (C) 2014-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Reason/Vacation.pm b/lib/Sisimai/Reason/Vacation.pm index bc58acd7..f67a1ff1 100644 --- a/lib/Sisimai/Reason/Vacation.pm +++ b/lib/Sisimai/Reason/Vacation.pm @@ -32,7 +32,7 @@ __END__ =head1 NAME -Sisimai::Reason::Vacation - A recipient is out of office +Sisimai::Reason::Vacation - the recipient is out of the office =head1 SYNOPSIS @@ -41,24 +41,24 @@ Sisimai::Reason::Vacation - A recipient is out of office =head1 DESCRIPTION -Sisimai::Reason::Vacation is for only returning text and description. This class is called only from -Sisimai->reason method. +C is for only returning the text and the description. +This class is called only from Creason()> method. =head1 CLASS METHODS =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::Vacation->text; # vacation =head2 C)>> -C always return undef +C method always return C =head2 C)>> -C always return undef +C method always return C =head1 AUTHOR diff --git a/lib/Sisimai/Reason/VirusDetected.pm b/lib/Sisimai/Reason/VirusDetected.pm index 013ebc43..8d4d00da 100644 --- a/lib/Sisimai/Reason/VirusDetected.pm +++ b/lib/Sisimai/Reason/VirusDetected.pm @@ -63,11 +63,11 @@ Sisimai::Reason::VirusDetected - Bounce reason is C or not. =head1 DESCRIPTION -Sisimai::Reason::VirusDetected checks the bounce reason is C or not. This class is -called only Sisimai::Reason class. +C checks the bounce reason is C or not. +This class is called only C class. -This is an error that any virus or trojan horse detected in the message by a virus scanner program -at a destination mail server. This reason has been divided from C at Sisimai 4.22.0. +This is an error that any virus or trojan horse detected in the message by the virus scanner program +at the destination mail server. This reason has been divided from C at Sisimai 4.22.0. Your message was infected with a virus. You should download a virus scanner and check your computer for viruses. @@ -79,21 +79,21 @@ at a destination mail server. This reason has been divided from C =head2 C> -C returns string: C. +C method returns the fixed string C. print Sisimai::Reason::VirusDetected->text; # virusdetected =head2 C)>> -C returns 1 if the argument matched with patterns defined in this class. +C method returns C<1> if the argument matched with patterns defined in this class. my $v = 'Your message was infected with a virus. ...'; print Sisimai::Reason::VirusDetected->match($v); # 1 =head2 C)>> -C returns 1 if the bounce reason is C. The argument must be Sisimai::Fact -object and this method is called only from Sisimai::Reason class. +C method returns C<1> if the bounce reason is C. The argument must be +C object and this method is called only from C class. =head1 AUTHOR @@ -108,3 +108,4 @@ Copyright (C) 2017-2021,2023,2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Rhost.pm b/lib/Sisimai/Rhost.pm index d579fd35..2eff1ae0 100644 --- a/lib/Sisimai/Rhost.pm +++ b/lib/Sisimai/Rhost.pm @@ -79,19 +79,19 @@ Sisimai::Rhost - Detect the bounce reason returned from certain remote hosts. =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument of -get() method when the value of C of the object is listed in $RhostClass variable. This class -is called only Sisimai::Fact class. +C detects the bounce reason from the content of C object as an argument +of C method when the value of C of the object is listed in C<$RhostClass> variable. +This class is called only C class. =head1 CLASS METHODS =head2 C)>> -Returns 1 if the remote host is listed in $RhostClass variable. +C method returns C<1> if the remote host is listed in C<$RhostClass> variable. =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/Apple.pm b/lib/Sisimai/Rhost/Apple.pm index 739991eb..714c65b7 100644 --- a/lib/Sisimai/Rhost/Apple.pm +++ b/lib/Sisimai/Rhost/Apple.pm @@ -93,19 +93,19 @@ Sisimai::Rhost::Apple - Detect the bounce reason returned from Apple iCloud Mail =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::Apple; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method when the value of C of the object end with "mail.icloud.com" or "apple.com". -This class is called only Sisimai::Fact class. +C detects the bounce reason from the content of C object as +an argument of C method when the value of C of the object end with C +or C. This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/Cox.pm b/lib/Sisimai/Rhost/Cox.pm index bd6c3fa7..2ecb9dbf 100644 --- a/lib/Sisimai/Rhost/Cox.pm +++ b/lib/Sisimai/Rhost/Cox.pm @@ -161,19 +161,19 @@ Sisimai::Rhost::Cox - Detect the bounce reason returned from Cox =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::Cox; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument of -get() method when the value of C or C of the object is "cox.net". This class is -called only Sisimai::Fact class. +C detects the bounce reason from the content of C object as an +argument of C method when the value of C or C of the object is C. +This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/FrancePTT.pm b/lib/Sisimai/Rhost/FrancePTT.pm index b3650305..155527ca 100644 --- a/lib/Sisimai/Rhost/FrancePTT.pm +++ b/lib/Sisimai/Rhost/FrancePTT.pm @@ -160,19 +160,19 @@ Sisimai::Rhost::FrancePTT - Detect the bounce reason returned from Orange and La =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::FrancePTT; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method when the value of C of the object end with "laposte.net" or "orange.fr". -This class is called only Sisimai::Fact class. +C detects the bounce reason from the content of C object +as an argument of C method when the value of C of the object end with C +or C. This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/GoDaddy.pm b/lib/Sisimai/Rhost/GoDaddy.pm index 117483e9..7fa1e4f0 100644 --- a/lib/Sisimai/Rhost/GoDaddy.pm +++ b/lib/Sisimai/Rhost/GoDaddy.pm @@ -239,19 +239,19 @@ Sisimai::Rhost::GoDaddy - Detect the bounce reason returned from GoDaddy. =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::GoDaddy; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method when the value of C of the object end with "secureserver.net". This class -is called only Sisimai::Fact class. +C detects the bounce reason from the content of C object as +an argument of C method when the value of C of the object end with C. +This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/Google.pm b/lib/Sisimai/Rhost/Google.pm index 5d1c4bcf..2236c871 100644 --- a/lib/Sisimai/Rhost/Google.pm +++ b/lib/Sisimai/Rhost/Google.pm @@ -547,19 +547,19 @@ Sisimai::Rhost::Google - Detect the bounce reason returned from Google Workspace =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::Google; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method when the value of C of the object is "aspmx.l.google.com". This class is -called only Sisimai::Fact class. +C detects the bounce reason from the content of C object as +an argument of C method when the value of C of the object is C. +This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR @@ -574,3 +574,4 @@ Copyright (C) 2014-2016,2018-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Rhost/IUA.pm b/lib/Sisimai/Rhost/IUA.pm index bf6cc96d..e17d63f7 100644 --- a/lib/Sisimai/Rhost/IUA.pm +++ b/lib/Sisimai/Rhost/IUA.pm @@ -41,19 +41,19 @@ Sisimai::Rhost::IUA - Detect the bounce reason returned from https://www.i.ua/. =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::IUA; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method when the value of C of the object is "*.email.ua". This class is called -only Sisimai::Fact class. +C detects the bounce reason from the content of C object as an +argument of C method when the value of C of the object is C<*.email.ua>. +This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/KDDI.pm b/lib/Sisimai/Rhost/KDDI.pm index 5db7601a..92ab318c 100644 --- a/lib/Sisimai/Rhost/KDDI.pm +++ b/lib/Sisimai/Rhost/KDDI.pm @@ -38,19 +38,19 @@ Sisimai::Rhost::KDDI - Detect the bounce reason returned from au (KDDI). =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::KDDI; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method when the value of C of the object is "msmx.au.com" or "lsean.ezweb.ne.jp". -This class is called only Sisimai::Fact class. +C detects the bounce reason from the content of C object as an +argument of C method when the value of C of the object is C or C. +This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/Microsoft.pm b/lib/Sisimai/Rhost/Microsoft.pm index 7e3bd00e..5265ed68 100644 --- a/lib/Sisimai/Rhost/Microsoft.pm +++ b/lib/Sisimai/Rhost/Microsoft.pm @@ -759,19 +759,19 @@ older and Office 365. =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::Microsoft; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method when the value of C of the object is "*.protection.outlook.com". This class -is called only Sisimai::Fact class. +C detects the bounce reason from the content of C object +as an argument of C method when the value of C of the object is C<*.protection.outlook.com>. +This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/Mimecast.pm b/lib/Sisimai/Rhost/Mimecast.pm index 37e14ddf..7b1e2d76 100644 --- a/lib/Sisimai/Rhost/Mimecast.pm +++ b/lib/Sisimai/Rhost/Mimecast.pm @@ -314,19 +314,19 @@ Sisimai::Rhost::Mimecast - Detect the bounce reason returned from Mimecast =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::Mimecast; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument of -get() method when the value of C or C of the object is "mimecast.com". This -class is called only Sisimai::Fact class. +C detects the bounce reason from the content of C object +as an argument of C method when the value of C or C of the object is +C. This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/NTTDOCOMO.pm b/lib/Sisimai/Rhost/NTTDOCOMO.pm index e39141d5..794c4e8f 100644 --- a/lib/Sisimai/Rhost/NTTDOCOMO.pm +++ b/lib/Sisimai/Rhost/NTTDOCOMO.pm @@ -121,19 +121,19 @@ Sisimai::Rhost::NTTDOCOMO - Detect the bounce reason returned from NTT docomo. =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::NTTDOCOMO; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method when the value of C of the object is "mfsmax.docomo.ne.jp". This class is -called only Sisimai::Fact class. +C detects the bounce reason from the content of C object +as an argument of C method when the value of C of the object is C. +This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/Spectrum.pm b/lib/Sisimai/Rhost/Spectrum.pm index 94f252b7..5a267f84 100644 --- a/lib/Sisimai/Rhost/Spectrum.pm +++ b/lib/Sisimai/Rhost/Spectrum.pm @@ -136,19 +136,19 @@ Sisimai::Rhost::Spectrum - Detect the bounce reason returned from Spectrum. =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::Spectrum; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method when the value of C or C of the object is "charter.net". This -class is called only Sisimai::Fact class. +C detects the bounce reason from the content of C object +as an argument of C method when the value of C or C of the object is +C. This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/Tencent.pm b/lib/Sisimai/Rhost/Tencent.pm index 0fead216..aa4bf9e5 100644 --- a/lib/Sisimai/Rhost/Tencent.pm +++ b/lib/Sisimai/Rhost/Tencent.pm @@ -71,23 +71,23 @@ __END__ =head1 NAME -Sisimai::Rhost::Tencent - Detect the bounce reason returned from Tencent . +Sisimai::Rhost::Tencent - Detect the bounce reason returned from Tencent. =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::Tencent; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method when the value of C of the object is "*.qq.com". This class is called only -Sisimai::Fact class. +C detects the bounce reason from the content of C object as +an argument of C method when the value of C of the object is C<*.qq.com>. This class +is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/Rhost/YahooInc.pm b/lib/Sisimai/Rhost/YahooInc.pm index bc848d75..e6e7bf11 100644 --- a/lib/Sisimai/Rhost/YahooInc.pm +++ b/lib/Sisimai/Rhost/YahooInc.pm @@ -103,19 +103,19 @@ Sisimai::Rhost::YahooInc - Detect the bounce reason returned from Yahoo Inc. =head1 SYNOPSIS - use Sisimai::Rhost; + use Sisimai::Rhost::YahooInc; =head1 DESCRIPTION -Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument -of get() method when the value of C of the object end with ".yahoodns.net". This class is -called only Sisimai::Fact class. +C detects the bounce reason from the content of C object +as an argument of C method when the value of C of the object end with C<*.yahoodns.net>. +This class is called only C class. =head1 CLASS METHODS =head2 C)>> -C detects the bounce reason. +C method detects the bounce reason. =head1 AUTHOR diff --git a/lib/Sisimai/SMTP.pm b/lib/Sisimai/SMTP.pm index 399ceadc..fceecd97 100644 --- a/lib/Sisimai/SMTP.pm +++ b/lib/Sisimai/SMTP.pm @@ -17,7 +17,7 @@ Sisimai::SMTP - SMTP Status Codes related utilities =head1 DESCRIPTION -Sisimai::SMTP is a parent class of Sisimai::SMTP::Status and Sisimai::SMTP::Reply. +C is a parent class of C, and C. =head1 AUTHOR diff --git a/lib/Sisimai/SMTP/Command.pm b/lib/Sisimai/SMTP/Command.pm index 2949e44e..40630f38 100644 --- a/lib/Sisimai/SMTP/Command.pm +++ b/lib/Sisimai/SMTP/Command.pm @@ -70,20 +70,20 @@ Sisimai::SMTP::Command - SMTP Command related utilities =head1 DESCRIPTION -Sisimai::SMTP::Command is a class for finding the last SMTP command from given error message. +C is a class for finding the last SMTP command from given error message. =head1 CLASS METHODS =head2 C)>> -C checks whether an SMTP command is a valid command or not +C method checks whether the SMTP command is a valid command or not print Sisimai::SMTP::Command->test('STARTTLS'); # 1 print Sisimai::SMTP::Command->test('NEKO'); # 0 =head2 C)>> -C returns the last SMTP command like the following: +C method returns the last SMTP command like the following: print Sisimai::SMTP::Command->find('MAIL FROM: <> 250 OK RCPT TO: <...> 550'); # "RCPT" diff --git a/lib/Sisimai/SMTP/Error.pm b/lib/Sisimai/SMTP/Error.pm index 1fec1f0f..2b383a56 100644 --- a/lib/Sisimai/SMTP/Error.pm +++ b/lib/Sisimai/SMTP/Error.pm @@ -126,13 +126,13 @@ Sisimai::SMTP::Error - SMTP Errors related utilities =head1 DESCRIPTION -Sisimai::SMTP::Error provide method to check an SMTP errors. +C provide methods to check an SMTP errors. =head1 CLASS METHODS =head2 C)>> -C checks the given string points an permanent error or not. +C method checks the given string points an permanent error or not. print Sisimai::SMTP::Error->is_permanent('5.1.1 User unknown'); # 1 print Sisimai::SMTP::Error->is_permanent('4.2.2 Mailbox Full'); # 0 @@ -140,9 +140,9 @@ C checks the given string points an permanent error or not. =head2 C, I)>> -C returns string 'soft' if given bounce reason is a soft bounce. When the reason is -a hard bounce, this method returns 'hard'. If the return value is an empty string, it means that -returned email may not be a bounce. +C method returns string C if given bounce reason is a soft bounce. When the +reason is a hard bounce, this method returns C. If the return value is an empty string, it +means that returned email may not be a bounce. print Sisimai::SMTP::Error->soft_or_hard('userunknown', '5.1.1 No such user'); # 'hard' print Sisimai::SMTP::Error->soft_or_hard('mailboxfull'); # 'soft' diff --git a/lib/Sisimai/SMTP/Reply.pm b/lib/Sisimai/SMTP/Reply.pm index d8eba331..c4114da1 100644 --- a/lib/Sisimai/SMTP/Reply.pm +++ b/lib/Sisimai/SMTP/Reply.pm @@ -192,13 +192,14 @@ Sisimai::SMTP::Reply - SMTP reply code related class =head1 DESCRIPTION -Sisimai::SMTP::Reply is utilities for getting SMTP reply code value from given error message text. +C is a utility class for getting the SMTP reply code value from given error +message text. =head1 CLASS METHODS =head2 C)>> -C checks whether a reply code is a valid code or not. +C method checks whether the reply code is a valid code or not. print Sisimai::SMTP::Reply->test('521'); # 1 print Sisimai::SMTP::Reply->test('386'); # 0 @@ -207,7 +208,7 @@ C checks whether a reply code is a valid code or not. =head2 C)>> -C returns an SMTP reply code value. +C method returns the SMTP reply code value. print Sisimai::SMTP::Reply->find('5.0.0'); # '' print Sisimai::SMTP::Reply->find('550 5.1.1 User unknown'); # 550 diff --git a/lib/Sisimai/SMTP/Status.pm b/lib/Sisimai/SMTP/Status.pm index 2e13cbd2..dd53576b 100644 --- a/lib/Sisimai/SMTP/Status.pm +++ b/lib/Sisimai/SMTP/Status.pm @@ -883,36 +883,36 @@ Sisimai::SMTP::Status - SMTP Enhanced Status Codes related utilities =head1 DESCRIPTION -Sisimai::SMTP::Status is utilities for getting DSN value from error reason text, getting the reason -from DSN value, and getting DSN from the text including DSN. +C is a utility class for getting the DSN value from the error reason text, +getting the reason from the DSN value, and getting the DSN from the text including a DSN. =head1 CLASS METHODS =head2 C,I)>> -C returns pseudo DSN value from the specified reason string. The second argument is a flag -for getting pseudo DSN value as a temporary error. +C method returns pseudo DSN value from the specified reason string. The second argument is +a flag for getting pseudo DSN value as a temporary error. print Sisimai::SMTP::Status->code('mailboxfull'); # '5.0.922' print Sisimai::SMTP::Status->code('mailboxfull',1); # '4.0.922' =head2 C)>> -C returns a reason string from the specified DSN value. +C method returns the reason string from the specified DSN value. print Sisimai::SMTP::Status->name('5.1.6'); # 'hasmoved' print Sisimai::SMTP::Status->name('4.2.3'); # 'exceedlimit' =head2 C)>> -C checks whether a status code is a valid code or not. +C method checks whether the status code is a valid code or not. print Sisimai::SMTP::Status->test('5.1.6'); # 1 print Sisimai::SMTP::Status->test('3.14'); # 0 =head2 C, I)>> -C returns a DSN value only from the text including DSN +C method returns the DSN value only from the text including a DSN print Sisimai::SMTP::Status->find('5.0.0'); # '5.0.0' print Sisimai::SMTP::Status->find('550 5.1.1 User unknown'); # '5.1.1' @@ -920,7 +920,7 @@ C returns a DSN value only from the text including DSN =head2 C, I, [I])>> -C returns the preferred value selected from the arguments. +C method returns the preferred value selected from the arguments. print Sisimai::SMTP::Status->prefer("5.2.1", "5.0.0"); # "5.2.1" print Sisimai::SMTP::Status->prefer("4.4.7", "5.1.1", 421); # "4.4.7" diff --git a/lib/Sisimai/SMTP/Transcript.pm b/lib/Sisimai/SMTP/Transcript.pm index 05e4f32f..2b5a11b8 100644 --- a/lib/Sisimai/SMTP/Transcript.pm +++ b/lib/Sisimai/SMTP/Transcript.pm @@ -139,8 +139,8 @@ Sisimai::SMTP::Transcript - Transcript of SMTP session parser =head1 DESCRIPTION -Sisimai::SMTP::Transcript provides a parser method for converting transcript of SMTP session to a -structured data. +C provides a decoding method for converting the transcript of the SMTP +session to the structured data. =head1 AUTHOR diff --git a/lib/Sisimai/String.pm b/lib/Sisimai/String.pm index 1a3c3d7b..5494a838 100644 --- a/lib/Sisimai/String.pm +++ b/lib/Sisimai/String.pm @@ -232,14 +232,14 @@ Sisimai::String - String related class =head1 DESCRIPTION -Sisimai::String provide utilities for dealing string +C provide utilities for dealing various strings =head1 CLASS METHODS =head2 C, I)>> -C generates a token: Unique string generated by an envelope sender address and a envelope -recipient address. +C method generates a C: an unique string generated by the envelope sender address +and the envelope recipient address. my $s = 'envelope-sender@example.jp'; my $r = 'envelope-recipient@example.org'; @@ -248,19 +248,19 @@ recipient address. =head2 C)>> -C checks the argument include any 8bit character or not. +C method checks the argument include any 8bit character or not. print Sisimai::String->is_8bit(\'cat'); # 0; print Sisimai::String->is_8bit(\'ねこ'); # 1; =head2 C)>> -C clean the argument string up: remove trailing spaces, squeeze spaces. +C method clean the argument string up: remove trailing spaces, squeeze spaces. print Sisimai::String->sweep(' cat neko '); # 'cat neko'; print Sisimai::String->sweep(' nyaa !!'); # 'nyaa !!'; -C checks if each element of the 2nd argument is aligned in the 1st argument or not. +C method checks if each element of the 2nd argument is aligned in the 1st argument or not. my $v = 'Final-Recipient: rfc822; '; print Sisimai::String->aligned(\$v, ['rfc822', '<', '@', '>']); # 1 @@ -269,26 +269,25 @@ C checks if each element of the 2nd argument is aligned in the 1st argu =head2 C)>> -C return all the IPv4 address found in the given string. +C method return all the IPv4 address found in the given string. my $v = "connection refused from 192.0.2.1, DNSBL returned 127.0.0.2"; my $p = Sisimai::String->ipv4($v); # ["192.0.2.1", "127.0.0.2"] =head2 C, [I])>> -C converts given string as HTML to plain text. +C method converts given string as an HTML to the plain text. my $v = 'neko'; print Sisimai::String->to_plain($v); # neko =head2 C, [I])>> -C converts given string to UTF-8. +C method converts given string to UTF-8. my $v = '^[$BG-^[(B'; # ISO-2022-JP print Sisimai::String->to_utf8($v, 'iso-2022-jp'); # 猫 - =head1 AUTHOR azumakuniyuki @@ -302,3 +301,4 @@ Copyright (C) 2014-2016,2018,2019,2021-2024 azumakuniyuki, All rights reserved. This software is distributed under The BSD 2-Clause License. =cut + diff --git a/lib/Sisimai/Time.pm b/lib/Sisimai/Time.pm index debc1ca2..2a66195d 100644 --- a/lib/Sisimai/Time.pm +++ b/lib/Sisimai/Time.pm @@ -18,7 +18,7 @@ __END__ =head1 NAME -Sisimai::Time - Child class of Time::Piece for Sisimai::Fact +Sisimai::Time - Child class of C for C =head1 SYNOPSIS @@ -27,7 +27,7 @@ Sisimai::Time - Child class of Time::Piece for Sisimai::Fact =head1 DESCRIPTION -Sisimai::Time is a child class of Time::Piece for Sisimai::Fact. +C is a child class of C for C. =head1 AUTHOR From a7bcddac15d84d4310e0a7d347482772526f3f4d Mon Sep 17 00:00:00 2001 From: azumakuniyuki Date: Sun, 16 Jun 2024 15:34:11 +0900 Subject: [PATCH 2/4] Follow up #527, Tiny comment improvement --- lib/Sisimai.pm | 6 +++--- lib/Sisimai/ARF.pm | 6 +++--- lib/Sisimai/Address.pm | 3 ++- lib/Sisimai/Fact.pm | 4 ++-- lib/Sisimai/Fact/YAML.pm | 2 +- lib/Sisimai/Lhost/Postfix.pm | 2 +- lib/Sisimai/Lhost/Sendmail.pm | 2 +- lib/Sisimai/MDA.pm | 6 +++--- lib/Sisimai/Message.pm | 16 ++++++++-------- lib/Sisimai/RFC2045.pm | 2 +- lib/Sisimai/RFC3464.pm | 8 ++++---- lib/Sisimai/RFC3834.pm | 4 ++-- lib/Sisimai/Reason.pm | 4 ++-- lib/Sisimai/Rhost.pm | 2 +- lib/Sisimai/Rhost/Apple.pm | 2 +- lib/Sisimai/Rhost/Cox.pm | 2 +- lib/Sisimai/Rhost/FrancePTT.pm | 2 +- lib/Sisimai/Rhost/GoDaddy.pm | 2 +- lib/Sisimai/Rhost/Google.pm | 2 +- lib/Sisimai/Rhost/IUA.pm | 2 +- lib/Sisimai/Rhost/KDDI.pm | 2 +- lib/Sisimai/Rhost/Microsoft.pm | 2 +- lib/Sisimai/Rhost/Mimecast.pm | 2 +- lib/Sisimai/Rhost/NTTDOCOMO.pm | 2 +- lib/Sisimai/Rhost/Spectrum.pm | 2 +- lib/Sisimai/Rhost/Tencent.pm | 4 ++-- lib/Sisimai/Rhost/YahooInc.pm | 2 +- lib/Sisimai/SMTP/Transcript.pm | 6 +++--- 28 files changed, 51 insertions(+), 50 deletions(-) diff --git a/lib/Sisimai.pm b/lib/Sisimai.pm index 43d51b6d..c3a58e23 100644 --- a/lib/Sisimai.pm +++ b/lib/Sisimai.pm @@ -232,7 +232,7 @@ messages like the following code: # dump() method also accepts "delivered" and "vacation" option like the following code: my $j = Sisimai->dump('/path/to/mbox', 'delivered' => 1, 'vacation' => 1); -=head1 OTHER WAYS TO PARSE +=head1 OTHER WAYS TO DECODE =head2 Read email data from STDIN @@ -298,8 +298,8 @@ dealing each email file. $e->{'catch'}->{'return-path'} = $1; } - # Save the original email with an additional "X-Sisimai-Parsed:" header to a different PATH. - my $a = sprintf("X-Sisimai-Parsed: %d\n", scalar @$fact); + # Save the original email with an additional "X-Sisimai-Decoded:" header to a different PATH. + my $a = sprintf("X-Sisimai-Decoded: %d\n", scalar @$fact); my $p = sprintf("/path/to/another/directory/sisimai-%s.eml", $e->token); my $f = IO::File->new($p, 'w'); my $v = $$mail; $v =~ s/^(From:.+)$/$a$1/m; diff --git a/lib/Sisimai/ARF.pm b/lib/Sisimai/ARF.pm index 61ea39d1..237d72c4 100644 --- a/lib/Sisimai/ARF.pm +++ b/lib/Sisimai/ARF.pm @@ -40,7 +40,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing my $class = shift; my $mhead = shift // return undef; my $mbody = shift // return undef; @@ -344,7 +344,7 @@ __END__ =head1 NAME -C - Parser class for detecting ARF: Abuse Feedback Reporting Format. +C - Decoder class for detecting ARF: Abuse Feedback Reporting Format. =head1 SYNOPSIS @@ -353,7 +353,7 @@ C - Parser class for detecting ARF: Abuse Feedback Reporting Forma =head1 DESCRIPTION -C is a parser for email returned as a Feedback Loop report message. +C is a decoder for email returned as a Feedback Loop report message. =head1 FEEDBACK TYPES diff --git a/lib/Sisimai/Address.pm b/lib/Sisimai/Address.pm index 753fc9ac..36b9577e 100644 --- a/lib/Sisimai/Address.pm +++ b/lib/Sisimai/Address.pm @@ -503,7 +503,8 @@ C method checks the argument is B or not. =head2 C)>> -C method is a new parser for getting only email address from text including email addresses. +C method is a new parser for getting only the email address from the given string including +an email addresses. my $r = 'Stray cat , nyaa@example.org (White Cat)', my $v = Sisimai::Address->find($r); diff --git a/lib/Sisimai/Fact.pm b/lib/Sisimai/Fact.pm index 3d8153b8..33fea7c4 100644 --- a/lib/Sisimai/Fact.pm +++ b/lib/Sisimai/Fact.pm @@ -143,7 +143,7 @@ sub rise { push @datevalues, $mesg1->{'header'}->{'date'} if scalar(@datevalues) < 2; while( my $v = shift @datevalues ) { - # Parse each date value in the array + # Decode each date value in the array $datestring = Sisimai::DateTime->parse($v); last if $datestring; } @@ -457,7 +457,7 @@ __END__ =head1 NAME -Sisimai::Fact - Parsed data object +Sisimai::Fact - Decoded data object =head1 SYNOPSIS diff --git a/lib/Sisimai/Fact/YAML.pm b/lib/Sisimai/Fact/YAML.pm index a4824d4b..eb2a934a 100644 --- a/lib/Sisimai/Fact/YAML.pm +++ b/lib/Sisimai/Fact/YAML.pm @@ -58,7 +58,7 @@ __END__ =head1 NAME -Sisimai::Fact::YAML - Dumps parsed data object as a YAML format +Sisimai::Fact::YAML - Dumps decoded data object as a YAML format =head1 SYNOPSIS diff --git a/lib/Sisimai/Lhost/Postfix.pm b/lib/Sisimai/Lhost/Postfix.pm index 7dcba37a..5d531dc0 100644 --- a/lib/Sisimai/Lhost/Postfix.pm +++ b/lib/Sisimai/Lhost/Postfix.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Postfix: https://www.postfix.org/' } sub inquire { - # Parse bounce messages from Postfix + # Decode bounce messages from Postfix # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/Sendmail.pm b/lib/Sisimai/Lhost/Sendmail.pm index 3c64a405..09e7f428 100644 --- a/lib/Sisimai/Lhost/Sendmail.pm +++ b/lib/Sisimai/Lhost/Sendmail.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Sendmail Open Source: https://sendmail.org/' } sub inquire { - # Parse bounce messages from Sendmail + # Decode bounce messages from Sendmail # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/MDA.pm b/lib/Sisimai/MDA.pm index 1ac5fbc3..c7385b4f 100644 --- a/lib/Sisimai/MDA.pm +++ b/lib/Sisimai/MDA.pm @@ -4,11 +4,11 @@ use strict; use warnings; sub inquire { - # Parse message body and return reason and text + # Decode the message body and return the MDA name, the reason and the error message text # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing my $class = shift; my $mhead = shift // return undef; my $mbody = shift // return undef; @@ -137,7 +137,7 @@ __END__ =head1 NAME -Sisimai::MDA - Error message parser for MDA +Sisimai::MDA - Error message decoder for MDA =head1 SYNOPSIS diff --git a/lib/Sisimai/Message.pm b/lib/Sisimai/Message.pm index c6eb89d4..a1a9bee8 100644 --- a/lib/Sisimai/Message.pm +++ b/lib/Sisimai/Message.pm @@ -364,7 +364,7 @@ sub sift { # @param options mail [Array] ds Delivery status list(decoded data) # @param options argvs [String] body Email message body # @param options argvs [Code] hook Hook method to be called - # @return [Hash] Parsed and structured bounce mails + # @return [Hash] Decoded and structured bounce mails my $class = shift; my $argvs = { @_ }; @@ -419,7 +419,7 @@ sub sift { my $haveloaded = {}; my $havesifted = undef; my $modulename = ''; - PARSER: while(1) { + DECODER: while(1) { # 1. User-Defined Module # 2. MTA Module Candidates to be tried on first # 3. Sisimai::Lhost::* @@ -432,7 +432,7 @@ sub sift { $havesifted = $r->inquire($mailheader, $bodystring); $haveloaded->{ $r } = 1; $modulename = $r; - last(PARSER) if $havesifted; + last(DECODER) if $havesifted; } TRY_ON_FIRST_AND_DEFAULTS: for my $r ( @$TryOnFirst, @$defaultset ) { @@ -442,7 +442,7 @@ sub sift { $havesifted = $r->inquire($mailheader, $bodystring); $haveloaded->{ $r } = 1; $modulename = $r; - last(PARSER) if $havesifted; + last(DECODER) if $havesifted; } unless( $haveloaded->{'Sisimai::RFC3464'} ) { @@ -450,14 +450,14 @@ sub sift { require Sisimai::RFC3464; $havesifted = Sisimai::RFC3464->inquire($mailheader, $bodystring); $modulename = 'RFC3464'; - last(PARSER) if $havesifted; + last(DECODER) if $havesifted; } unless( $haveloaded->{'Sisimai::ARF'} ) { # Feedback Loop message require Sisimai::ARF; $havesifted = Sisimai::ARF->inquire($mailheader, $bodystring); - last(PARSER) if $havesifted; + last(DECODER) if $havesifted; } unless( $haveloaded->{'Sisimai::RFC3834'} ) { @@ -465,11 +465,11 @@ sub sift { require Sisimai::RFC3834; $havesifted = Sisimai::RFC3834->inquire($mailheader, $bodystring); $modulename = 'RFC3834'; - last(PARSER) if $havesifted; + last(DECODER) if $havesifted; } last; # as of now, we have no sample email for coding this block - } # End of while(PARSER) + } # End of while(DECODER) return undef unless $havesifted; $havesifted->{'catch'} = $havecaught; diff --git a/lib/Sisimai/RFC2045.pm b/lib/Sisimai/RFC2045.pm index 2fae7709..29dadc71 100644 --- a/lib/Sisimai/RFC2045.pm +++ b/lib/Sisimai/RFC2045.pm @@ -439,7 +439,7 @@ C method breaks the C message block into each part and re =head2 C, I<\String>)>> C method makes flat C message: This method breaks C block into -each part, remove parts which are not needed to parse the bounce message such as C MIME +each part, remove parts which are not needed to decode the bounce message such as C MIME type, and decode the encoded text part (C, C) in the body of each part that has C header and the value of the header is quoted-printabe, base64, or 7bit. diff --git a/lib/Sisimai/RFC3464.pm b/lib/Sisimai/RFC3464.pm index 96a3dc9a..a8c66964 100644 --- a/lib/Sisimai/RFC3464.pm +++ b/lib/Sisimai/RFC3464.pm @@ -11,7 +11,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing my $class = shift; my $mhead = shift // return undef; my $mbody = shift // return undef; @@ -178,8 +178,8 @@ sub inquire { } # --------------------------------------------------------------------------------------------- - BODY_PARSER_FOR_FALLBACK: { - # Fallback, parse entire message body + BODY_DECODER_FOR_FALLBACK: { + # Fallback, decode the entire message body last if $recipients; # Failed to get a recipient address at code above @@ -351,7 +351,7 @@ sub inquire { } $b->{'diagnosis'} .= ' '.$e; } - } # END OF BODY_PARSER_FOR_FALLBACK + } # END OF BODY_DECODER_FOR_FALLBACK return undef unless $itisbounce; my $p1 = index($rfc822text, "\nTo: "); diff --git a/lib/Sisimai/RFC3834.pm b/lib/Sisimai/RFC3834.pm index db5c325a..ee7b21ae 100644 --- a/lib/Sisimai/RFC3834.pm +++ b/lib/Sisimai/RFC3834.pm @@ -10,7 +10,7 @@ sub inquire { # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part - # @return [undef] failed to parse or the arguments are missing + # @return [undef] failed to decode or the arguments are missing # @since v4.1.28 my $class = shift; my $mhead = shift // return undef; @@ -107,7 +107,7 @@ sub inquire { $markingsof->{'boundary'} = $q if $q; } - BODY_PARSER: { + MESSAGE_BODY: { # Get vacation message for my $e ( split("\n", $$mbody) ) { # Read the first 5 lines except a blank line diff --git a/lib/Sisimai/Reason.pm b/lib/Sisimai/Reason.pm index 2bb18d32..a6c4cce1 100644 --- a/lib/Sisimai/Reason.pm +++ b/lib/Sisimai/Reason.pm @@ -54,7 +54,7 @@ sub path { sub get { # Detect the bounce reason - # @param [Hash] argvs Parsed email object + # @param [Hash] argvs Decoded email object # @return [String] Bounce reason or undef if the argument is missing or not HASH # @see anotherone my $class = shift; @@ -102,7 +102,7 @@ sub get { sub anotherone { # Detect the other bounce reason, fall back method for get() - # @param [Hash] argvs Parsed email structure + # @param [Hash] argvs Decoded email structure # @return [String] Bounce reason or undef if the argument is missing or not HASH # @see get my $class = shift; diff --git a/lib/Sisimai/Rhost.pm b/lib/Sisimai/Rhost.pm index 2eff1ae0..73b8549c 100644 --- a/lib/Sisimai/Rhost.pm +++ b/lib/Sisimai/Rhost.pm @@ -40,7 +40,7 @@ sub match { sub get { # Detect the bounce reason from certain remote hosts - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @param [String] proxy The alternative of the "rhost" # @return [String] The value of bounce reason my $class = shift; diff --git a/lib/Sisimai/Rhost/Apple.pm b/lib/Sisimai/Rhost/Apple.pm index 714c65b7..d3ad0d66 100644 --- a/lib/Sisimai/Rhost/Apple.pm +++ b/lib/Sisimai/Rhost/Apple.pm @@ -5,7 +5,7 @@ use warnings; sub get { # Detect bounce reason from Apple iCloud Mail - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason for Apple # @see https://support.apple.com/en-us/102322 # https://www.postmastery.com/icloud-postmastery-page/ diff --git a/lib/Sisimai/Rhost/Cox.pm b/lib/Sisimai/Rhost/Cox.pm index 2ecb9dbf..1d3709b9 100644 --- a/lib/Sisimai/Rhost/Cox.pm +++ b/lib/Sisimai/Rhost/Cox.pm @@ -5,7 +5,7 @@ use warnings; sub get { # Detect bounce reason from https://cox.com/ - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason at Cox # @see https://www.cox.com/residential/support/email-error-codes.html # @since v4.25.8 diff --git a/lib/Sisimai/Rhost/FrancePTT.pm b/lib/Sisimai/Rhost/FrancePTT.pm index 155527ca..343318bd 100644 --- a/lib/Sisimai/Rhost/FrancePTT.pm +++ b/lib/Sisimai/Rhost/FrancePTT.pm @@ -5,7 +5,7 @@ use warnings; sub get { # Detect bounce reason from Orange and La Poste - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decdoed email object # @return [String] The bounce reason for Orange, La Poste # @see https://www.postmastery.com/orange-postmaster-smtp-error-codes-ofr/ # https://smtpfieldmanual.com/provider/orange diff --git a/lib/Sisimai/Rhost/GoDaddy.pm b/lib/Sisimai/Rhost/GoDaddy.pm index 7fa1e4f0..0c2cee47 100644 --- a/lib/Sisimai/Rhost/GoDaddy.pm +++ b/lib/Sisimai/Rhost/GoDaddy.pm @@ -6,7 +6,7 @@ use warnings; # https://www.godaddy.com/help/what-does-my-email-bounceback-mean-3568 sub get { # Detect bounce reason from GoDaddy (smtp.secureserver.net) - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason for GoDaddy # @see https://ca.godaddy.com/help/fix-rejected-email-with-a-bounce-error-40685 # @since v4.22.2 diff --git a/lib/Sisimai/Rhost/Google.pm b/lib/Sisimai/Rhost/Google.pm index 2236c871..4f54f409 100644 --- a/lib/Sisimai/Rhost/Google.pm +++ b/lib/Sisimai/Rhost/Google.pm @@ -5,7 +5,7 @@ use warnings; sub get { # Detect bounce reason from Google Workspace - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason for Google Workspace # @see https://support.google.com/a/answer/3726730?hl=en # @since v4.0.0 diff --git a/lib/Sisimai/Rhost/IUA.pm b/lib/Sisimai/Rhost/IUA.pm index e17d63f7..92a0da77 100644 --- a/lib/Sisimai/Rhost/IUA.pm +++ b/lib/Sisimai/Rhost/IUA.pm @@ -5,7 +5,7 @@ use warnings; sub get { # Detect bounce reason from https://www.i.ua/ - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason at https://www.i.ua/ # @since v4.25.0 my $class = shift; diff --git a/lib/Sisimai/Rhost/KDDI.pm b/lib/Sisimai/Rhost/KDDI.pm index 92ab318c..787cd041 100644 --- a/lib/Sisimai/Rhost/KDDI.pm +++ b/lib/Sisimai/Rhost/KDDI.pm @@ -5,7 +5,7 @@ use warnings; sub get { # Detect bounce reason from au(KDDI) - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason au.com and ezweb.ne.jp # @since v4.22.6 my $class = shift; diff --git a/lib/Sisimai/Rhost/Microsoft.pm b/lib/Sisimai/Rhost/Microsoft.pm index 5265ed68..68aae8ac 100644 --- a/lib/Sisimai/Rhost/Microsoft.pm +++ b/lib/Sisimai/Rhost/Microsoft.pm @@ -9,7 +9,7 @@ use Sisimai::SMTP::Status; # https://learn.microsoft.com/en-us/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/non-delivery-reports-and-bounce-messages sub get { # Detect bounce reason from Exchange Server 2019 or older and Exchange Online - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason for Exchange Online # @see https://technet.microsoft.com/en-us/library/bb232118 # @since v4.17.2 diff --git a/lib/Sisimai/Rhost/Mimecast.pm b/lib/Sisimai/Rhost/Mimecast.pm index 7b1e2d76..215abb3c 100644 --- a/lib/Sisimai/Rhost/Mimecast.pm +++ b/lib/Sisimai/Rhost/Mimecast.pm @@ -6,7 +6,7 @@ use Sisimai::SMTP::Reply; sub get { # Detect bounce reason from https://www.mimecast.com/ - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason at Mimecast # @since v4.25.15 my $class = shift; diff --git a/lib/Sisimai/Rhost/NTTDOCOMO.pm b/lib/Sisimai/Rhost/NTTDOCOMO.pm index 794c4e8f..f30e7b94 100644 --- a/lib/Sisimai/Rhost/NTTDOCOMO.pm +++ b/lib/Sisimai/Rhost/NTTDOCOMO.pm @@ -5,7 +5,7 @@ use warnings; sub get { # Detect bounce reason from NTT docomo - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason for docomo.ne.jp # @since v4.25.15 my $class = shift; diff --git a/lib/Sisimai/Rhost/Spectrum.pm b/lib/Sisimai/Rhost/Spectrum.pm index 5a267f84..b08dbf75 100644 --- a/lib/Sisimai/Rhost/Spectrum.pm +++ b/lib/Sisimai/Rhost/Spectrum.pm @@ -5,7 +5,7 @@ use warnings; sub get { # Detect bounce reason from https://www.spectrum.com/ - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason at Spectrum # @since v4.25.8 my $class = shift; diff --git a/lib/Sisimai/Rhost/Tencent.pm b/lib/Sisimai/Rhost/Tencent.pm index aa4bf9e5..b5fe7404 100644 --- a/lib/Sisimai/Rhost/Tencent.pm +++ b/lib/Sisimai/Rhost/Tencent.pm @@ -4,8 +4,8 @@ use strict; use warnings; sub get { - # Detect bounce reason from Tencent - # @param [Sisimai::Fact] argvs Parsed email object + # Detect bounce reason from Tencent + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason at Tencent # @see https://service.mail.qq.com/detail/122 # @since v4.25.0 diff --git a/lib/Sisimai/Rhost/YahooInc.pm b/lib/Sisimai/Rhost/YahooInc.pm index e6e7bf11..ee1434b0 100644 --- a/lib/Sisimai/Rhost/YahooInc.pm +++ b/lib/Sisimai/Rhost/YahooInc.pm @@ -5,7 +5,7 @@ use warnings; sub get { # Detect bounce reason from Yahoo Inc. (*.yahoodns.net) - # @param [Sisimai::Fact] argvs Parsed email object + # @param [Sisimai::Fact] argvs Decoded email object # @return [String] The bounce reason for YahooInc # @see https://senders.yahooinc.com/smtp-error-codes # https://smtpfieldmanual.com/provider/yahoo diff --git a/lib/Sisimai/SMTP/Transcript.pm b/lib/Sisimai/SMTP/Transcript.pm index 2b5a11b8..5fdc4eec 100644 --- a/lib/Sisimai/SMTP/Transcript.pm +++ b/lib/Sisimai/SMTP/Transcript.pm @@ -7,12 +7,12 @@ use Sisimai::SMTP::Status; use Sisimai::SMTP::Command; sub rise { - # Parse a transcript of an SMTP session and makes structured data + # Decode the transcript of the SMTP session and makes the structured data # @param [String] argv0 A transcript text MTA returned # @param [String] argv1 A label string of a SMTP client # @param [String] argv2 A label string of a SMTP server # @return [Array] Structured data - # @return [undef] Failed to parse or the 1st argument is missing + # @return [undef] Failed to decode or the 1st argument is missing # @since v5.0.0 my $class = shift; my $argv0 = shift // return undef; @@ -130,7 +130,7 @@ __END__ =head1 NAME -Sisimai::SMTP::Transcript - Transcript of SMTP session parser +Sisimai::SMTP::Transcript - Transcript of the SMTP session decoder =head1 SYNOPSIS From 65102f42453e3493a5ec91643196b73300d3d5d4 Mon Sep 17 00:00:00 2001 From: azumakuniyuki Date: Sun, 16 Jun 2024 16:25:30 +0900 Subject: [PATCH 3/4] Replace "G Suite" with "Google Workspace" --- lib/Sisimai/Lhost/GSuite.pm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/Sisimai/Lhost/GSuite.pm b/lib/Sisimai/Lhost/GSuite.pm index 595ed3ea..aa4b1c52 100644 --- a/lib/Sisimai/Lhost/GSuite.pm +++ b/lib/Sisimai/Lhost/GSuite.pm @@ -4,9 +4,9 @@ use v5.26; use strict; use warnings; -sub description { 'G Suite: https://workspace.google.com/' } +sub description { 'Google Workspace: https://workspace.google.com/' } sub inquire { - # Detect an error from G Suite (Transfer from G Suite to a destination host) + # Detect an error from Google Workspace (Transfer from the Google Workspace to the destination host) # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part From 7c78f336b7a663564613c94e7d6f9b876f351dee Mon Sep 17 00:00:00 2001 From: azumakuniyuki Date: Sun, 16 Jun 2024 18:35:54 +0900 Subject: [PATCH 4/4] Some product names updated --- lib/Sisimai/Lhost/Activehunter.pm | 5 +++-- lib/Sisimai/Lhost/Domino.pm | 2 +- lib/Sisimai/Lhost/Exim.pm | 2 +- lib/Sisimai/Lhost/IMailServer.pm | 7 ++++--- lib/Sisimai/Lhost/InterScanMSS.pm | 2 +- lib/Sisimai/Lhost/MXLogic.pm | 2 +- lib/Sisimai/Lhost/MailMarshalSMTP.pm | 2 +- lib/Sisimai/Lhost/McAfee.pm | 2 +- lib/Sisimai/Lhost/MessageLabs.pm | 2 +- lib/Sisimai/Lhost/Notes.pm | 2 +- lib/Sisimai/Lhost/Office365.pm | 2 +- lib/Sisimai/Lhost/SendGrid.pm | 2 +- lib/Sisimai/Lhost/Sendmail.pm | 2 +- lib/Sisimai/Lhost/Yahoo.pm | 2 +- lib/Sisimai/Lhost/Yandex.pm | 2 +- lib/Sisimai/Lhost/mFILTER.pm | 2 +- 16 files changed, 21 insertions(+), 19 deletions(-) diff --git a/lib/Sisimai/Lhost/Activehunter.pm b/lib/Sisimai/Lhost/Activehunter.pm index 2fc17bf9..fb402f85 100644 --- a/lib/Sisimai/Lhost/Activehunter.pm +++ b/lib/Sisimai/Lhost/Activehunter.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'TransWARE Active!hunter' }; sub inquire { - # Detect an error from TransWARE Active!hunter + # Detect an error from QUALITIA Active!hunter # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part @@ -81,7 +81,8 @@ __END__ =head1 NAME -Sisimai::Lhost::Activehunter - bounce mail decodeder class for Active!hunter L +Sisimai::Lhost::Activehunter - bounce mail decodeder class for QUALITIA Active!hunter +L =head1 SYNOPSIS diff --git a/lib/Sisimai/Lhost/Domino.pm b/lib/Sisimai/Lhost/Domino.pm index ce1a9836..5f5e6935 100644 --- a/lib/Sisimai/Lhost/Domino.pm +++ b/lib/Sisimai/Lhost/Domino.pm @@ -9,7 +9,7 @@ use Encode::Guess; Encode::Guess->add_suspects(Sisimai::String->encodenames->@*) sub description { 'HCL Domino' } sub inquire { - # Detect an error from HCL Domino + # Detect an error from HCL Domino (Formerly IBM Domino (Formerly Lotus Domino)) # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/Exim.pm b/lib/Sisimai/Lhost/Exim.pm index b41651e5..5eeeac2f 100644 --- a/lib/Sisimai/Lhost/Exim.pm +++ b/lib/Sisimai/Lhost/Exim.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Exim' } sub inquire { - # Detect an error from Exim + # Detect an error from Exim Internet Mailer # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/IMailServer.pm b/lib/Sisimai/Lhost/IMailServer.pm index b915022d..51b924d9 100644 --- a/lib/Sisimai/Lhost/IMailServer.pm +++ b/lib/Sisimai/Lhost/IMailServer.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Progress iMail Server: https://community.progress.com/s/products/imailserver' } sub inquire { - # Detect an error from IMailServer + # Detect an error from Progress iMail Server # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part @@ -106,7 +106,8 @@ __END__ =head1 NAME -Sisimai::Lhost::IMailServer - bounce mail decoder class for iMail Server L. +Sisimai::Lhost::IMailServer - bounce mail decoder class for Progress iMail Server +L. =head1 SYNOPSIS @@ -114,7 +115,7 @@ Sisimai::Lhost::IMailServer - bounce mail decoder class for iMail Server L decodes a bounce email which created by Progress iMail Server +C decodes a bounce email which created by Progress iMail Server L. Methods in the module are called from only C. diff --git a/lib/Sisimai/Lhost/InterScanMSS.pm b/lib/Sisimai/Lhost/InterScanMSS.pm index 46ca4aea..09f966ab 100644 --- a/lib/Sisimai/Lhost/InterScanMSS.pm +++ b/lib/Sisimai/Lhost/InterScanMSS.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Trend Micro InterScan Messaging Security Suite: https://www.trendmicro.com/en_us/business/products/user-protection/sps/email-and-collaboration/interscan-messaging.html' } sub inquire { - # Detect an error from InterScanMSS + # Detect an error from Trend Micro InterScan Messaging Security Suite # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/MXLogic.pm b/lib/Sisimai/Lhost/MXLogic.pm index 03861302..f147df25 100644 --- a/lib/Sisimai/Lhost/MXLogic.pm +++ b/lib/Sisimai/Lhost/MXLogic.pm @@ -7,7 +7,7 @@ use warnings; # Based on Sisimai::Lhost::Exim sub description { 'McAfee SaaS' } sub inquire { - # Detect an error from MXLogic + # Detect an error from McAfee Saas (Formerly MXLogic) # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/MailMarshalSMTP.pm b/lib/Sisimai/Lhost/MailMarshalSMTP.pm index 9b506799..c524d824 100644 --- a/lib/Sisimai/Lhost/MailMarshalSMTP.pm +++ b/lib/Sisimai/Lhost/MailMarshalSMTP.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Trustwave Secure Email Gateway: https://www.trustwave.com/en-us/services/email-security/' } sub inquire { - # Detect an error from MailMarshalSMTP + # Detect an error from Trustwave Secure Email Gateway (Formerly MailMarshalSMTP) # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/McAfee.pm b/lib/Sisimai/Lhost/McAfee.pm index 0b29ca31..80885524 100644 --- a/lib/Sisimai/Lhost/McAfee.pm +++ b/lib/Sisimai/Lhost/McAfee.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'McAfee Email Appliance' } sub inquire { - # Detect an error from McAfee + # Detect an error from McAfee Email Appliance # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/MessageLabs.pm b/lib/Sisimai/Lhost/MessageLabs.pm index 0dc8c451..228a0d27 100644 --- a/lib/Sisimai/Lhost/MessageLabs.pm +++ b/lib/Sisimai/Lhost/MessageLabs.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Email Security (formerly Messaging Security): https://www.broadcom.com/products/cybersecurity/email' } sub inquire { - # Detect an error from MessageLabs.com + # Detect an error from Email Security (Formerly MessageLabs.com) # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/Notes.pm b/lib/Sisimai/Lhost/Notes.pm index 68ac3bc0..ad39bb48 100644 --- a/lib/Sisimai/Lhost/Notes.pm +++ b/lib/Sisimai/Lhost/Notes.pm @@ -7,7 +7,7 @@ use Encode; sub description { 'HCL Notes' } sub inquire { - # Detect an error from Lotus Notes + # Detect an error from HCL Notes (Formerly IBM Notes(Formerly Lotus Notes)) # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/Office365.pm b/lib/Sisimai/Lhost/Office365.pm index b3723c1c..e060de6d 100644 --- a/lib/Sisimai/Lhost/Office365.pm +++ b/lib/Sisimai/Lhost/Office365.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Microsoft 365: https://office.microsoft.com/' } sub inquire { - # Detect an error from Microsoft Office 365 + # Detect an error from Microsoft 365 (formerly Office 365) # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/SendGrid.pm b/lib/Sisimai/Lhost/SendGrid.pm index 9a186845..864c6b8a 100644 --- a/lib/Sisimai/Lhost/SendGrid.pm +++ b/lib/Sisimai/Lhost/SendGrid.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Twilio SendGrid: https://sendgrid.com/' } sub inquire { - # Detect an error from SendGrid + # Detect an error from Twilio SendGrid # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/Sendmail.pm b/lib/Sisimai/Lhost/Sendmail.pm index 09e7f428..b9e3bad3 100644 --- a/lib/Sisimai/Lhost/Sendmail.pm +++ b/lib/Sisimai/Lhost/Sendmail.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Sendmail Open Source: https://sendmail.org/' } sub inquire { - # Decode bounce messages from Sendmail + # Decode bounce messages from Sendmail Open Source # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/Yahoo.pm b/lib/Sisimai/Lhost/Yahoo.pm index 92fd072f..8a9c623e 100644 --- a/lib/Sisimai/Lhost/Yahoo.pm +++ b/lib/Sisimai/Lhost/Yahoo.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Yahoo MAIL: https://mail.yahoo.com/' } sub inquire { - # Detect an error from Yahoo! MAIL + # Detect an error from Yahoo Mail # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/Yandex.pm b/lib/Sisimai/Lhost/Yandex.pm index 511c6321..f9f89e91 100644 --- a/lib/Sisimai/Lhost/Yandex.pm +++ b/lib/Sisimai/Lhost/Yandex.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Yandex Mail: https://360.yandex.com/mail/' } sub inquire { - # Detect an error from Yandex.Mail + # Detect an error from Yandex Mail # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part diff --git a/lib/Sisimai/Lhost/mFILTER.pm b/lib/Sisimai/Lhost/mFILTER.pm index e5e20548..7c4a5157 100644 --- a/lib/Sisimai/Lhost/mFILTER.pm +++ b/lib/Sisimai/Lhost/mFILTER.pm @@ -6,7 +6,7 @@ use warnings; sub description { 'Digital Arts m-FILTER: https://www.daj.jp/bs/mf/' } sub inquire { - # Detect an error from DigitalArts m-FILTER + # Detect an error from Digital Arts m-FILTER # @param [Hash] mhead Message headers of a bounce email # @param [String] mbody Message body of a bounce email # @return [Hash] Bounce data list and message/rfc822 part