.\" -*- 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 "Mail::SPF::Base 3pm"
.TH Mail::SPF::Base 3pm 2023-07-25 "perl v5.38.0" "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
Mail::SPF::Base \- Base class for Mail::SPF classes
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use base \*(AqMail::SPF::Base\*(Aq;
\&
\&    sub new {
\&        my ($class, @options) = @_;
\&        my $self = $class\->SUPER::new(@options);
\&        ...
\&        return $self;
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBMail::SPF::Base\fR is a common base class for all \fBMail::SPF\fR classes.
.SS Constructor
.IX Subsection "Constructor"
The following constructor is provided:
.IP "\fBnew(%options)\fR: returns \fIMail::SPF::Base\fR" 4
.IX Item "new(%options): returns Mail::SPF::Base"
Creates a new object of the class on which the constructor was invoked.  The
provided options are stored as key/value pairs in the new object.
.Sp
The \f(CW\*(C`new\*(C'\fR constructor may also be called on an object, in which case the
object is cloned.  Any options provided override those from the old object.
.Sp
There are no common options defined in \fBMail::SPF::Base\fR.
.SS "Class methods"
.IX Subsection "Class methods"
The following class methods are provided:
.IP "\fBclass\fR: returns \fIstring\fR" 4
.IX Item "class: returns string"
Returns the class name of the class or object on which it is invoked.
.SS "Class methods"
.IX Subsection "Class methods"
The following class methods are provided:
.ie n .IP "\fBmake_accessor($name, \fR\fB$readonly\fR\fB)\fR: returns \fIcode-ref\fR" 4
.el .IP "\fBmake_accessor($name, \fR\f(CB$readonly\fR\fB)\fR: returns \fIcode-ref\fR" 4
.IX Item "make_accessor($name, $readonly): returns code-ref"
Creates an accessor method in the class on which it is invoked.  The accessor
has the given name and accesses the object field of the same name.  If
\&\f(CW$readonly\fR is \fBtrue\fR, the accessor is made read-only.
.SS "Instance methods"
.IX Subsection "Instance methods"
There are no common instance methods defined in \fBMail::SPF::Base\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::SPF
.PP
For availability, support, and license information, see the README file
included with Mail::SPF.
.SH AUTHORS
.IX Header "AUTHORS"
Julian Mehnle <julian@mehnle.net>, Shevek <cpan@anarres.org>