/usr/share/perl5/Email/Send.pm is in libemail-send-perl 2.198-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | package Email::Send;
use strict;
use vars qw[$VERSION];
$VERSION = '2.198';
use Email::Simple;
use Module::Pluggable
search_path => 'Email::Send',
except => $Email::Send::__plugin_exclusion;
use Return::Value;
use Scalar::Util ();
=head1 NAME
Email::Send - Simply Sending Email
=head1 WAIT! ACHTUNG!
Email::Send is going away... well, not really going away, but it's being
officially marked "out of favor." It has API design problems that make it hard
to usefully extend and rather than try to deprecate features and slowly ease in
a new interface, we've released Email::SendB<er> which fixes these problems and
others. As of today, 2008-12-19, Email::Sender is young, but it's fairly
well-tested. Please consider using it instead for any new work.
=head1 SYNOPSIS
use Email::Send;
my $message = <<'__MESSAGE__';
To: recipient@example.com
From: sender@example.com
Subject: Hello there folks
How are you? Enjoy!
__MESSAGE__
my $sender = Email::Send->new({mailer => 'SMTP'});
$sender->mailer_args([Host => 'smtp.example.com']);
$sender->send($message);
# more complex
my $bulk = Email::Send->new;
for ( qw[SMTP Sendmail Qmail] ) {
$bulk->mailer($_) and last if $bulk->mailer_available($_);
}
$bulk->message_modifier(sub {
my ($sender, $message, $to) = @_;
$message->header_set(To => qq[$to\@geeknest.com])
});
my @to = qw[casey chastity evelina casey_jr marshall];
my $rv = $bulk->send($message, $_) for @to;
=head1 DESCRIPTION
This module provides a very simple, very clean, very specific interface
to multiple Email mailers. The goal of this software is to be small
and simple, easy to use, and easy to extend.
=head2 Constructors
=over 4
=item new
my $sender = Email::Send->new({
mailer => 'NNTP',
mailer_args => [ Host => 'nntp.example.com' ],
});
Create a new mailer object. This method can take parameters for any of the data
properties of this module. Those data properties, which have their own accessors,
are listed under L<"Properties">.
=back
=head2 Properties
=over 4
=item mailer
The mailing system you'd like to use for sending messages with this object.
This is not defined by default. If you don't specify a mailer, all available
plugins will be tried when the C<send> method is called until one succeeds.
=item mailer_args
Arguments passed into the mailing system you're using.
=item message_modifier
If defined, this callback is invoked every time the C<send> method is called
on an object. The mailer object will be passed as the first argument. Second,
the actual C<Email::Simple> object for a message will be passed. Finally, any
additional arguments passed to C<send> will be passed to this method in the
order they were received.
This is useful if you are sending in bulk.
=back
=cut
sub new {
my ($class, $args) = @_;
$args->{mailer_args} ||= [];
my %plugins = map {
my ($short_name) = /^Email::Send::(.+)/;
($short_name, $_);
} $class->plugins;
$args->{_plugin_list} = \%plugins;
return bless $args => $class;
}
BEGIN {
for my $field (qw(mailer mailer_args message_modifier _plugin_list)) {
my $code = sub {
return $_[0]->{$field} unless @_ > 1;
my $self = shift;
$self->{$field} = (@_ == 1 ? $_[0] : [@_]);
};
no strict 'refs';
*$field = $code;
}
}
=head2 METHODS
=over 4
=item send
my $result = $sender->send($message, @modifier_args);
Send a message using the predetermined mailer and mailer arguments. If you
have defined a C<message_modifier> it will be called prior to sending.
The first argument you pass to send is an email message. It must be in some
format that C<Email::Abstract> can understand. If you don't have
C<Email::Abstract> installed then sending as plain text or an C<Email::Simple>
object will do.
Any remaining arguments will be passed directly into your defined
C<message_modifier>.
=cut
sub send {
goto &_send_function unless eval { $_[0]->isa('Email::Send') };
my ($self, $message, @args) = @_;
my $simple = $self->_objectify_message($message);
return failure "No message found." unless $simple;
$self->message_modifier->(
$self, $simple,
@args,
) if $self->message_modifier;
if ( $self->mailer ) {
return $self->_send_it($self->mailer, $simple);
}
return $self->_try_all($simple);
}
=item all_mailers
my @available = $sender->all_mailers;
Returns a list of availabe mailers. These are mailers that are
installed on your computer and register themselves as available.
=cut
sub all_mailers {
my ($self) = @_;
my @mailers;
for ( keys %{$self->_plugin_list} ) {
push @mailers, $_ if $self->mailer_available($_);
}
return @mailers;
}
=item mailer_available
# is SMTP over SSL avaialble?
$sender->mailer('SMTP')
if $sender->mailer_available('SMTP', ssl => 1);
Given the name of a mailer, such as C<SMTP>, determine if it is
available. Any additional arguments passed to this method are passed
directly to the C<is_available> method of the mailer being queried.
=back
=cut
sub mailer_available {
my ($self, $mailer, @args) = @_;
my $invocant = $self->_mailer_invocant($mailer);
return $invocant unless $invocant;
$invocant->can('is_available')
or return failure "Mailer $mailer doesn't report availability.";
my $test = $invocant->is_available(@args);
return $test unless $test;
return success;
}
sub _objectify_message {
my ($self, $message) = @_;
return undef unless defined $message;
return $message if UNIVERSAL::isa($message, 'Email::Simple');
return Email::Simple->new($message) unless ref($message);
return Email::Abstract->cast($message => 'Email::Simple')
if eval { require Email::Abstract };
return undef;
}
sub _mailer_invocant {
my ($self, $mailer) = @_;
return $mailer if Scalar::Util::blessed($mailer);
# is the mailer a plugin given by short name?
my $package = exists $self->_plugin_list->{$mailer}
? $self->_plugin_list->{$mailer}
: $mailer;
eval "require $package" or return failure "$@";
return $package;
}
sub _send_it {
my ($self, $mailer, $message) = @_;
my $test = $self->mailer_available($mailer);
return $test unless $test;
my $invocant = $self->_mailer_invocant($mailer);
return $invocant->send($message, @{$self->mailer_args});
}
sub _try_all {
my ($self, $simple) = @_;
foreach ( $self->all_mailers ) {
my $sent = $self->_send_it($_, $simple);
return $sent if $sent;
}
return failure "Unable to send message.";
}
# Classic Interface.
sub import {
no strict 'refs';
*{(caller)[0] . '::send'} = __PACKAGE__->can('_send_function');
}
sub _send_function {
my ($mailer, $message, @args) = @_;
__PACKAGE__->new({
mailer => $mailer,
mailer_args => \@args,
})->send($message);
}
1;
__END__
=head2 Writing Mailers
package Email::Send::Example;
sub is_available {
eval { use Net::Example }
}
sub send {
my ($class, $message, @args) = @_;
use Net::Example;
Net::Example->do_it($message) or return;
}
1;
Writing new mailers is very simple. If you want to use a short name
when calling C<send>, name your mailer under the C<Email::Send> namespace.
If you don't, the full name will have to be used. A mailer only needs
to implement a single function, C<send>. It will be called from
C<Email::Send> exactly like this.
Your::Sending::Package->send($message, @args);
C<$message> is an Email::Simple object, C<@args> are the extra
arguments passed into C<Email::Send::send>.
Here's an example of a mailer that sends email to a URL.
package Email::Send::HTTP::Post;
use strict;
use vars qw[$AGENT $URL $FIELD];
use Return::Value;
sub is_available {
eval { use LWP::UserAgent }
}
sub send {
my ($class, $message, @args);
require LWP::UserAgent;
if ( @args ) {
my ($URL, $FIELD) = @args;
$AGENT = LWP::UserAgent->new;
}
return failure "Can't send to URL if no URL and field are named"
unless $URL && $FIELD;
$AGENT->post($URL => { $FIELD => $message->as_string });
return success;
}
1;
This example will keep a UserAgent singleton unless new arguments are
passed to C<send>. It is used by calling C<Email::Send::send>.
my $sender = Email::Send->new({ mailer => 'HTTP::Post' });
$sender->mailer_args([ 'http://example.com/incoming', 'message' ]);
$sender->send($message);
$sender->send($message2); # uses saved $URL and $FIELD
=head1 SEE ALSO
L<Email::Simple>,
L<Email::Abstract>,
L<Email::Send::IO>,
L<Email::Send::NNTP>,
L<Email::Send::Qmail>,
L<Email::Send::SMTP>,
L<Email::Send::Sendmail>,
L<perl>.
=head1 PERL EMAIL PROJECT
This module is maintained by the Perl Email Project.
L<http://emailproject.perl.org/wiki/Email::Send>
=head1 AUTHOR
Current maintainer: Ricardo SIGNES, <F<rjbs@cpan.org>>.
Original author: Casey West, <F<casey@geeknest.com>>.
=head1 COPYRIGHT
Copyright (c) 2005 Casey West. All rights reserved.
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut
|