.\" -*- 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::Reason::OnHold 3pm"
.TH Sisimai::Reason::OnHold 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::Reason::OnHold \- Bounce reason is "onhold" or not.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    use Sisimai::Reason::OnHold;
\&    print Sisimai::Reason::OnHold\->match; # 0
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Sisimai::Reason::OnHold checks the bounce reason is \f(CW\*(C`onhold\*(C'\fR or not. This class is called only
Sisimai::Reason class. Sisimai will set \f(CW\*(C`onhold\*(C'\fR to the reason of email bounce if there is no (or
less) detailed information about email bounce for judging the reason.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.ie n .SS """\fBtext()\fP"""
.el .SS \f(CW\fP\f(CBtext()\fP\f(CW\fP
.IX Subsection "text()"
\&\f(CWtext()\fR returns string: \f(CW\*(C`onhold\*(C'\fR.
.PP
.Vb 1
\&    print Sisimai::Reason::OnHold\->text;  # onhold
.Ve
.ie n .SS """\fBmatch(string)\fP"""
.el .SS \f(CW\fP\f(CBmatch(string)\fP\f(CW\fP
.IX Subsection "match(string)"
\&\f(CWmatch()\fR returns 1 if the argument matched with patterns defined in this class.
.PP
.Vb 1
\&    print Sisimai::Reason::OnHold\->match; # 0;
.Ve
.ie n .SS """\fBtrue(Sisimai::Fact)\fP"""
.el .SS \f(CW\fP\f(CBtrue(Sisimai::Fact)\fP\f(CW\fP
.IX Subsection "true(Sisimai::Fact)"
\&\f(CWtrue()\fR returns 1 if the bounce reason is \f(CW\*(C`onhold\*(C'\fR. The argument must be Sisimai::Fact object
and this method is called only from Sisimai::Reason class.
.SH AUTHOR
.IX Header "AUTHOR"
azumakuniyuki
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2014\-2016,2018,2020,2021 azumakuniyuki, All rights reserved.
.SH LICENSE
.IX Header "LICENSE"
This software is distributed under The BSD 2\-Clause License.