.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Sisimai::SMTP::Status 3pm"
.TH Sisimai::SMTP::Status 3pm 2024-03-16 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Sisimai::SMTP::Status \- SMTP Enhanced Status Codes related utilities
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&    use Sisimai::SMTP::Status;
\&    print Sisimai::SMTP::Status\->code(\*(Aquserunknown\*(Aq);           # \*(Aq5.0.911\*(Aq
\&    print Sisimai::SMTP::Status\->name(\*(Aq5.1.2\*(Aq);                 # \*(Aqhostunknown\*(Aq
\&    print Sisimai::SMTP::Status\->find(\*(Aq550 5.1.1 Unknown user\*(Aq);# \*(Aq5.1.1\*(Aq
.Ve
.SH DESCRIPTION
.IX Header "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.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.ie n .SS """\fBcode(reason,temp)\fP"""
.el .SS \f(CW\fP\f(CBcode(reason,temp)\fP\f(CW\fP
.IX Subsection "code(reason,temp)"
\&\f(CWcode()\fR returns pseudo DSN value from the specified reason string. The second argument is a flag
for getting pseudo DSN value as a temporary error.
.PP
.Vb 2
\&    print Sisimai::SMTP::Status\->code(\*(Aqmailboxfull\*(Aq);   # \*(Aq5.0.922\*(Aq
\&    print Sisimai::SMTP::Status\->code(\*(Aqmailboxfull\*(Aq,1); # \*(Aq4.0.922\*(Aq
.Ve
.ie n .SS """\fBname(D.S.N.)\fP"""
.el .SS \f(CW\fP\f(CBname(D.S.N.)\fP\f(CW\fP
.IX Subsection "name(D.S.N.)"
\&\f(CWname()\fR returns a reason string from the specified DSN value.
.PP
.Vb 2
\&    print Sisimai::SMTP::Status\->name(\*(Aq5.1.6\*(Aq);         # \*(Aqhasmoved\*(Aq
\&    print Sisimai::SMTP::Status\->name(\*(Aq4.2.3\*(Aq);         # \*(Aqexceedlimit\*(Aq
.Ve
.ie n .SS """\fBtest(D.S.N.)\fP"""
.el .SS \f(CW\fP\f(CBtest(D.S.N.)\fP\f(CW\fP
.IX Subsection "test(D.S.N.)"
\&\f(CWtest()\fR checks whether a status code is a valid code or not.
.PP
.Vb 2
\&    print Sisimai::SMTP::Status\->test(\*(Aq5.1.6\*(Aq); # 1
\&    print Sisimai::SMTP::Status\->test(\*(Aq3.14\*(Aq);  # 0
.Ve
.ie n .SS """\fBfind(String, String)\fP"""
.el .SS "\f(CW\fP\f(CBfind(String, String)\fP\f(CW\fP"
.IX Subsection "find(String, String)"
\&\f(CWfind()\fR returns a DSN value only from the text including DSN
.PP
.Vb 3
\&    print Sisimai::SMTP::Status\->find(\*(Aq5.0.0\*(Aq);                  # \*(Aq5.0.0\*(Aq
\&    print Sisimai::SMTP::Status\->find(\*(Aq550 5.1.1 User unknown\*(Aq); # \*(Aq5.1.1\*(Aq
\&    print Sisimai::SMTP::Status\->find(\*(Aq447 delivery expired\*(Aq);   # \*(Aq\*(Aq
.Ve
.ie n .SS """\fBprefer(Code in Status: field, Code in an error message, [Reply code])\fP"""
.el .SS "\f(CW\fP\f(CBprefer(Code in Status: field, Code in an error message, [Reply code])\fP\f(CW\fP"
.IX Subsection "prefer(Code in Status: field, Code in an error message, [Reply code])"
\&\f(CWprefer()\fR returns the preferred value selected from the arguments.
.PP
.Vb 2
\&    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"
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
azumakuniyuki
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2015\-2018,2020\-2024 azumakuniyuki, All rights reserved.
.SH LICENSE
.IX Header "LICENSE"
This software is distributed under The BSD 2\-Clause License.