📁 File Manager Pro
v10.0.3 | PHP: 8.1.34
Server: Apache
2026-06-21 06:50:09
📂
/ (Root)
/
usr
/
local
/
share
/
perl5
/
Email
📍 /usr/local/share/perl5/Email
🔄 Refresh
✏️
Editing: Abstract.pm
Read Only
use 5.006; use warnings; use strict; package Email::Abstract; # ABSTRACT: unified interface to mail representations $Email::Abstract::VERSION = '3.010'; use Carp; use Email::Simple; use MRO::Compat; use Module::Pluggable 1.5 search_path => [__PACKAGE__], except => 'Email::Abstract::Plugin', require => 1; use Scalar::Util (); my @plugins = __PACKAGE__->plugins(); # Requires them. my %adapter_for = map { $_->target => $_ } grep { my $avail = eval { $_->is_available }; $@ ? ($@ =~ /Can't locate object method "is_available"/) : $avail; } @plugins; sub object { my ($self) = @_; return unless ref $self; return $self->[0]; } sub new { my ($class, $foreign) = @_; return $foreign if eval { $foreign->isa($class) }; $foreign = Email::Simple->new($foreign) unless Scalar::Util::blessed($foreign); my $adapter = $class->__class_for($foreign); # dies if none available return bless [ $foreign, $adapter ] => $class; } sub __class_for { my ($self, $foreign, $method, $skip_super) = @_; $method ||= 'handle'; my $f_class = ref $foreign; $f_class = $foreign unless $f_class; return $f_class if ref $foreign and $f_class->isa($self); return $adapter_for{$f_class} if $adapter_for{$f_class}; if (not $skip_super) { my @bases = @{ mro::get_linear_isa($f_class) }; shift @bases; for my $base (@bases) { return $adapter_for{$base} if $adapter_for{$base}; } } Carp::croak "Don't know how to $method $f_class"; } sub _adapter_obj_and_args { my $self = shift; if (my $thing = $self->object) { return ($self->[1], $thing, @_); } else { my $thing = shift; my $adapter = $self->__class_for( Scalar::Util::blessed($thing) ? $thing : 'Email::Simple' ); return ($adapter, $thing, @_); } } for my $func (qw(get_header get_body set_header set_body as_string)) { no strict 'refs'; *$func = sub { my $self = shift; my ($adapter, $thing, @args) = $self->_adapter_obj_and_args(@_); # In the event of Email::Abstract->get_body($email_abstract), convert # it into an object method call. $thing = $thing->object if eval { $thing->isa($self) }; # I suppose we could work around this by leaving @_ intact and assigning to # it. That seems ... not good. -- rjbs, 2007-07-18 unless (Scalar::Util::blessed($thing)) { Carp::croak "can't alter string in place" if substr($func, 0, 3) eq 'set'; $thing = Email::Simple->new( ref $thing ? \do{my$str=$$thing} : $thing ); } return $adapter->$func($thing, @args); }; } sub cast { my $self = shift; my ($from_adapter, $from, $to) = $self->_adapter_obj_and_args(@_); my $adapter = $self->__class_for($to, 'construct', 1); my $from_string = ref($from) ? $from_adapter->as_string($from) : $from; return $adapter->construct($from_string); } 1; =pod =encoding UTF-8 =head1 NAME Email::Abstract - unified interface to mail representations =head1 VERSION version 3.010 =head1 SYNOPSIS my $message = Mail::Message->read($rfc822) || Email::Simple->new($rfc822) || Mail::Internet->new([split /\n/, $rfc822]) || ... || $rfc822; my $email = Email::Abstract->new($message); my $subject = $email->get_header("Subject"); $email->set_header(Subject => "My new subject"); my $body = $email->get_body; $rfc822 = $email->as_string; my $mail_message = $email->cast("Mail::Message"); =head1 DESCRIPTION C<Email::Abstract> provides module writers with the ability to write simple, representation-independent mail handling code. For instance, in the cases of C<Mail::Thread> or C<Mail::ListDetector>, a key part of the code involves reading the headers from a mail object. Where previously one would either have to specify the mail class required, or to build a new object from scratch, C<Email::Abstract> can be used to perform certain simple operations on an object regardless of its underlying representation. C<Email::Abstract> currently supports C<Mail::Internet>, C<MIME::Entity>, C<Mail::Message>, C<Email::Simple>, C<Email::MIME>, and C<Courriel>. Other representations are encouraged to create their own C<Email::Abstract::*> class by copying C<Email::Abstract::EmailSimple>. All modules installed under the C<Email::Abstract> hierarchy will be automatically picked up and used. =head1 PERL VERSION This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years. Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. =head1 METHODS All of these methods may be called either as object methods or as class methods. When called as class methods, the email object (of any class supported by Email::Abstract) must be prepended to the list of arguments, like so: my $return = Email::Abstract->method($message, @args); This is provided primarily for backwards compatibility. =head2 new my $email = Email::Abstract->new($message); Given a message, either as a string or as an object for which an adapter is installed, this method will return a Email::Abstract object wrapping the message. If the message is given as a string, it will be used to construct an object, which will then be wrapped. =head2 get_header my $header = $email->get_header($header_name); my @headers = $email->get_header($header_name); This returns the values for the given header. In scalar context, it returns the first value. =head2 set_header $email->set_header($header => @values); This sets the C<$header> header to the given one or more values. =head2 get_body my $body = $email->get_body; This returns the body as a string. =head2 set_body $email->set_body($string); This changes the body of the email to the given string. B<WARNING!> You probably don't want to call this method, despite what you may think. Email message bodies are complicated, and rely on things like content type, encoding, and various MIME requirements. If you call C<set_body> on a message more complicated than a single-part seven-bit plain-text message, you are likely to break something. If you need to do this sort of thing, you should probably use a specific message class from end to end. This method is left in place for backwards compatibility. =head2 as_string my $string = $email->as_string; This returns the whole email as a decoded string. =head2 cast my $mime_entity = $email->cast('MIME::Entity'); This method will convert a message from one message class to another. It will throw an exception if no adapter for the target class is known, or if the adapter does not provide a C<construct> method. =head2 object my $message = $email->object; This method returns the message object wrapped by Email::Abstract. If called as a class method, it returns false. Note that, because strings are converted to message objects before wrapping, this method will return an object when the Email::Abstract was constructed from a string. =head1 AUTHORS =over 4 =item * Ricardo SIGNES <cpan@semiotic.systems> =item * Simon Cozens <simon@cpan.org> =item * Casey West <casey@geeknest.com> =back =head1 CONTRIBUTORS =for stopwords Dave Rolsky Ricardo Signes William Yardley =over 4 =item * Dave Rolsky <autarch@urth.org> =item * Ricardo Signes <rjbs@semiotic.systems> =item * William Yardley <pep@veggiechinese.net> =back =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2004 by Simon Cozens. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =cut __END__ #pod =head1 SYNOPSIS #pod #pod my $message = Mail::Message->read($rfc822) #pod || Email::Simple->new($rfc822) #pod || Mail::Internet->new([split /\n/, $rfc822]) #pod || ... #pod || $rfc822; #pod #pod my $email = Email::Abstract->new($message); #pod #pod my $subject = $email->get_header("Subject"); #pod $email->set_header(Subject => "My new subject"); #pod #pod my $body = $email->get_body; #pod #pod $rfc822 = $email->as_string; #pod #pod my $mail_message = $email->cast("Mail::Message"); #pod #pod =head1 DESCRIPTION #pod #pod C<Email::Abstract> provides module writers with the ability to write #pod simple, representation-independent mail handling code. For instance, in the #pod cases of C<Mail::Thread> or C<Mail::ListDetector>, a key part of the code #pod involves reading the headers from a mail object. Where previously one would #pod either have to specify the mail class required, or to build a new object from #pod scratch, C<Email::Abstract> can be used to perform certain simple operations on #pod an object regardless of its underlying representation. #pod #pod C<Email::Abstract> currently supports C<Mail::Internet>, C<MIME::Entity>, #pod C<Mail::Message>, C<Email::Simple>, C<Email::MIME>, and C<Courriel>. Other #pod representations are encouraged to create their own C<Email::Abstract::*> class #pod by copying C<Email::Abstract::EmailSimple>. All modules installed under the #pod C<Email::Abstract> hierarchy will be automatically picked up and used. #pod #pod =head1 METHODS #pod #pod All of these methods may be called either as object methods or as class #pod methods. When called as class methods, the email object (of any class #pod supported by Email::Abstract) must be prepended to the list of arguments, like #pod so: #pod #pod my $return = Email::Abstract->method($message, @args); #pod #pod This is provided primarily for backwards compatibility. #pod #pod =head2 new #pod #pod my $email = Email::Abstract->new($message); #pod #pod Given a message, either as a string or as an object for which an adapter is #pod installed, this method will return a Email::Abstract object wrapping the #pod message. #pod #pod If the message is given as a string, it will be used to construct an object, #pod which will then be wrapped. #pod #pod =head2 get_header #pod #pod my $header = $email->get_header($header_name); #pod #pod my @headers = $email->get_header($header_name); #pod #pod This returns the values for the given header. In scalar context, it returns #pod the first value. #pod #pod =head2 set_header #pod #pod $email->set_header($header => @values); #pod #pod This sets the C<$header> header to the given one or more values. #pod #pod =head2 get_body #pod #pod my $body = $email->get_body; #pod #pod This returns the body as a string. #pod #pod =head2 set_body #pod #pod $email->set_body($string); #pod #pod This changes the body of the email to the given string. #pod #pod B<WARNING!> You probably don't want to call this method, despite what you may #pod think. Email message bodies are complicated, and rely on things like content #pod type, encoding, and various MIME requirements. If you call C<set_body> on a #pod message more complicated than a single-part seven-bit plain-text message, you #pod are likely to break something. If you need to do this sort of thing, you #pod should probably use a specific message class from end to end. #pod #pod This method is left in place for backwards compatibility. #pod #pod =head2 as_string #pod #pod my $string = $email->as_string; #pod #pod This returns the whole email as a decoded string. #pod #pod =head2 cast #pod #pod my $mime_entity = $email->cast('MIME::Entity'); #pod #pod This method will convert a message from one message class to another. It will #pod throw an exception if no adapter for the target class is known, or if the #pod adapter does not provide a C<construct> method. #pod #pod =head2 object #pod #pod my $message = $email->object; #pod #pod This method returns the message object wrapped by Email::Abstract. If called #pod as a class method, it returns false. #pod #pod Note that, because strings are converted to message objects before wrapping, #pod this method will return an object when the Email::Abstract was constructed from #pod a string. #pod #pod =cut
💾 Save Changes
❌ Cancel