File: //usr/local/ssl/local/share/man/man3/Mail::Field::Generic.3
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Mail::Field::Generic 3"
.TH Mail::Field::Generic 3 "2010-01-26" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Mail::Field::Generic \- implementation for inspecific fields
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 2
\& Mail::Field::Generic
\& is a Mail::Field
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use Mail::Field;
\& my $field = Mail::Field->new('Subject', 'some subject text');
\& my $field = Mail::Field->new(subject => 'some subject text');
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A generic implementation for header fields without own
implementation. This is fine for fields like \f(CW\*(C`Subject\*(C'\fR, \f(CW\*(C`X\-Mailer\*(C'\fR,
etc., where the field holds only a string of no particular
importance/format.
.SH "METHODS"
.IX Header "METHODS"
.Sh "Constructors"
.IX Subsection "Constructors"
Mail::Field::Generic\->\fBcombine\fR(\s-1FIELDS\s0)
.Sp
.RS 4
See \*(L"Constructors\*(R" in Mail::Field
.RE
.PP
Mail::Field::Generic\->\fBextract\fR(\s-1TAG\s0, \s-1HEAD\s0 [, \s-1INDEX\s0 ])
.Sp
.RS 4
See \*(L"Constructors\*(R" in Mail::Field
.RE
.PP
Mail::Field::Generic\->\fBnew\fR(\s-1TAG\s0 [, \s-1STRING\s0 | \s-1OPTIONS\s0])
.Sp
.RS 4
See \*(L"Constructors\*(R" in Mail::Field
.RE
.ie n .Sh """Fake"" constructors"
.el .Sh "``Fake'' constructors"
.IX Subsection "Fake constructors"
$obj\->\fBcreate\fR(\s-1OPTIONS\s0)
.Sp
.Vb 2
\& Option--Default
\& Text ''
.Ve
.Sp
.RS 4
\&. Text => \s-1STRING\s0
.RE
.PP
$obj\->\fBparse\fR([\s-1STRING\s0])
.Sp
.RS 4
Set the new text, which is empty when no \s-1STRING\s0 is provided.
.RE
.Sh "Accessors"
.IX Subsection "Accessors"
$obj\->\fBset\fR(\s-1OPTIONS\s0)
.Sp
.RS 4
See \*(L"Accessors\*(R" in Mail::Field
.RE
.PP
$obj\->\fBstringify\fR
.Sp
.RS 4
See \*(L"Accessors\*(R" in Mail::Field
.RE
.PP
$obj\->\fBtag\fR
.PP
Mail::Field::Generic\->\fBtag\fR
.Sp
.RS 4
See \*(L"Accessors\*(R" in Mail::Field
.RE
.Sh "Smart accessors"
.IX Subsection "Smart accessors"
$obj\->\fBtext\fR([\s-1STRING\s0])
.Sp
.RS 4
See \*(L"Smart accessors\*(R" in Mail::Field
.RE
.SH "DETAILS"
.IX Header "DETAILS"
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
Error: Undefined subroutine <method> called
.Sp
.RS 4
Mail::Field objects use autoloading to compile new functionality.
Apparently, the mehod called is not implemented for the specific
class of the field object.
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of the MailTools distribution,
\&\fIhttp://perl.overmeer.net/mailtools/\fR.
.SH "AUTHORS"
.IX Header "AUTHORS"
The MailTools bundle was developed by Graham Barr. Later, Mark
Overmeer took over maintenance without commitment to further development.
.PP
Mail::Cap by Gisle Aas <aas@oslonett.no>.
Mail::Field::AddrList by Peter Orbaek <poe@cit.dk>.
Mail::Mailer and Mail::Send by Tim Bunce <Tim.Bunce@ig.co.uk>.
For other contributors see ChangeLog.
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 1995\-2000 Graham Barr <gbarr@pobox.com> and
2001\-2007 Mark Overmeer <perl@overmeer.net>.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR