home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / share / perl5 / Mail / Field / Generic.pod < prev   
Encoding:
Text File  |  2008-07-29  |  2.5 KB  |  148 lines
  1. =head1 NAME
  2.  
  3. Mail::Field::Generic - implementation for inspecific fields
  4.  
  5. =head1 INHERITANCE
  6.  
  7.  Mail::Field::Generic
  8.    is a Mail::Field
  9.  
  10. =head1 SYNOPSIS
  11.  
  12.  use Mail::Field;
  13.  my $field = Mail::Field->new('Subject', 'some subject text');
  14.  my $field = Mail::Field->new(subject => 'some subject text');
  15.  
  16. =head1 DESCRIPTION
  17.  
  18. A generic implementation for header fields without own
  19. implementation. This is fine for fields like C<Subject>, C<X-Mailer>,
  20. etc., where the field holds only a string of no particular
  21. importance/format.
  22.  
  23. =head1 METHODS
  24.  
  25. =head2 Constructors
  26.  
  27. Mail::Field::Generic-E<gt>B<combine>(FIELDS)
  28.  
  29. =over 4
  30.  
  31. See L<Mail::Field/"Constructors">
  32.  
  33. =back
  34.  
  35. Mail::Field::Generic-E<gt>B<extract>(TAG, HEAD [, INDEX ])
  36.  
  37. =over 4
  38.  
  39. See L<Mail::Field/"Constructors">
  40.  
  41. =back
  42.  
  43. Mail::Field::Generic-E<gt>B<new>(TAG [, STRING | OPTIONS])
  44.  
  45. =over 4
  46.  
  47. See L<Mail::Field/"Constructors">
  48.  
  49. =back
  50.  
  51. =head2 "Fake" constructors
  52.  
  53. $obj-E<gt>B<create>(OPTIONS)
  54.  
  55. =over 4
  56.  
  57.  Option--Default
  58.  Text    ''
  59.  
  60. . Text => STRING
  61.  
  62. =back
  63.  
  64. $obj-E<gt>B<parse>([STRING])
  65.  
  66. =over 4
  67.  
  68. Set the new text, which is empty when no STRING is provided.
  69.  
  70. =back
  71.  
  72. =head2 Accessors
  73.  
  74. $obj-E<gt>B<set>(OPTIONS)
  75.  
  76. =over 4
  77.  
  78. See L<Mail::Field/"Accessors">
  79.  
  80. =back
  81.  
  82. $obj-E<gt>B<stringify>
  83.  
  84. =over 4
  85.  
  86. See L<Mail::Field/"Accessors">
  87.  
  88. =back
  89.  
  90. $obj-E<gt>B<tag>
  91.  
  92. Mail::Field::Generic-E<gt>B<tag>
  93.  
  94. =over 4
  95.  
  96. See L<Mail::Field/"Accessors">
  97.  
  98. =back
  99.  
  100. =head2 Smart accessors
  101.  
  102. $obj-E<gt>B<text>([STRING])
  103.  
  104. =over 4
  105.  
  106. See L<Mail::Field/"Smart accessors">
  107.  
  108. =back
  109.  
  110. =head1 DETAILS
  111.  
  112. =head1 DIAGNOSTICS
  113.  
  114. Error: Undefined subroutine <method> called
  115.  
  116. =over 4
  117.  
  118. Mail::Field objects use autoloading to compile new functionality.
  119. Apparently, the mehod called is not implemented for the specific
  120. class of the field object.
  121.  
  122. =back
  123.  
  124. =head1 SEE ALSO
  125.  
  126. This module is part of the MailTools distribution,
  127. F<http://perl.overmeer.net/mailtools/>.
  128.  
  129. =head1 AUTHORS
  130.  
  131. The MailTools bundle was developed by Graham Barr.  Later, Mark
  132. Overmeer took over maintenance without commitment to further development.
  133.  
  134. Mail::Cap by Gisle Aas E<lt>aas@oslonett.noE<gt>.
  135. Mail::Field::AddrList by Peter Orbaek E<lt>poe@cit.dkE<gt>.
  136. Mail::Mailer and Mail::Send by Tim Bunce E<lt>Tim.Bunce@ig.co.ukE<gt>.
  137. For other contributors see ChangeLog.
  138.  
  139. =head1 LICENSE
  140.  
  141. Copyrights 1995-2000 Graham Barr E<lt>gbarr@pobox.comE<gt> and
  142. 2001-2007 Mark Overmeer E<lt>perl@overmeer.netE<gt>.
  143.  
  144. This program is free software; you can redistribute it and/or modify it
  145. under the same terms as Perl itself.
  146. See F<http://www.perl.com/perl/misc/Artistic.html>
  147.  
  148.