Mail::Field::Generic

Section: User Contributed Perl Documentation (3pm)
Updated: 2010-01-26
Index Return to Main Contents

NAME

Mail::Field::Generic - implementation for inspecific fields

INHERITANCE

 Mail::Field::Generic
   is a Mail::Field

SYNOPSIS

 use Mail::Field;
 my $field = Mail::Field->new('Subject', 'some subject text');
 my $field = Mail::Field->new(subject => 'some subject text');

DESCRIPTION

A generic implementation for header fields without own implementation. This is fine for fields like "Subject", "X-Mailer", etc., where the field holds only a string of no particular importance/format.

METHODS

Constructors

Mail::Field::Generic->combine(FIELDS)

: See ``Constructors'' in Mail::Field

Mail::Field::Generic->extract(TAG, HEAD [, INDEX ])

: See ``Constructors'' in Mail::Field

Mail::Field::Generic->new(TAG [, STRING | OPTIONS])

: See ``Constructors'' in Mail::Field

Fake constructors

$obj->create(OPTIONS)

 Option--Default
 Text    ''

: . Text => STRING

$obj->parse([STRING])

: Set the new text, which is empty when no STRING is provided.

Accessors

$obj->set(OPTIONS)

: See ``Accessors'' in Mail::Field

$obj->stringify

: See ``Accessors'' in Mail::Field

$obj->tag

Mail::Field::Generic->tag

: See ``Accessors'' in Mail::Field

Smart accessors

$obj->text([STRING])

: See ``Smart accessors'' in Mail::Field

DETAILS

DIAGNOSTICS

Error: Undefined subroutine <method> called

: Mail::Field objects use autoloading to compile new functionality. Apparently, the mehod called is not implemented for the specific class of the field object.

AUTHORS

The MailTools bundle was developed by Graham Barr. Later, Mark Overmeer took over maintenance without commitment to further development.

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.

LICENSE

Copyrights 1995-2000 Graham Barr <gbarr@pobox.com> and 2001-2007 Mark Overmeer <perl@overmeer.net>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html

This document was created by man2html, using the manual pages.
Time: 19:49:23 GMT, April 27, 2011