3 # Copyright (c) 1995-1997 Graham Barr <gbarr@pobox.com>. All rights reserved.
4 # This program is free software; you can redistribute it and/or
5 # modify it under the same terms as Perl itself.
12 use vars qw($VERSION @ISA);
19 $VERSION = "2.19"; # $Id: //depot/libnet/Net/SMTP.pm#20 $
21 @ISA = qw(Net::Cmd IO::Socket::INET);
26 my $type = ref($self) || $self;
27 my $host = shift if @_ % 2;
29 my $hosts = defined $host ? [ $host ] : $NetConfig{smtp_hosts};
33 foreach $h (@{$hosts})
35 $obj = $type->SUPER::new(PeerAddr => ($host = $h),
36 PeerPort => $arg{Port} || 'smtp(25)',
38 Timeout => defined $arg{Timeout}
49 $obj->debug(exists $arg{Debug} ? $arg{Debug} : undef);
51 unless ($obj->response() == CMD_OK)
57 ${*$obj}{'net_smtp_host'} = $host;
59 (${*$obj}{'net_smtp_banner'}) = $obj->message;
60 (${*$obj}{'net_smtp_domain'}) = $obj->message =~ /\A\s*(\S+)/;
62 unless($obj->hello($arg{Hello} || ""))
72 ## User interface methods
79 return ${*$me}{'net_smtp_banner'} || undef;
86 return ${*$me}{'net_smtp_domain'} || undef;
91 defined($self->supports('ETRN',500,["Command unknown: 'ETRN'"])) &&
95 sub auth { # auth(username, password) by mengwong 20011106. the only supported mechanism at this time is PLAIN.
97 # my $auth = $smtp->supports("AUTH");
98 # $smtp->auth("username", "password") or die $smtp->message;
101 require MIME::Base64;
104 my ($username, $password) = @_;
105 die "auth(username, password)" if not length $username;
107 my $mechanisms = $self->supports('AUTH',500,["Command unknown: 'AUTH'"]);
108 return unless defined $mechanisms;
110 if (not grep { uc $_ eq "PLAIN" } split ' ', $mechanisms) {
111 $self->set_status(500, ["PLAIN mechanism not supported; server supports $mechanisms"]);
114 my $authstring = MIME::Base64::encode_base64(join "\0", ($username)x2, $password);
115 $authstring =~ s/\n//g; # wrap long lines
117 $self->_AUTH("PLAIN $authstring");
123 my $domain = shift || "localhost.localdomain";
124 my $ok = $me->_EHLO($domain);
125 my @msg = $me->message;
129 my $h = ${*$me}{'net_smtp_esmtp'} = {};
133 if $ln =~ /(\S+)\b[ \t]*([^\n]*)/;
136 elsif($me->status == CMD_ERROR)
139 if $ok = $me->_HELO($domain);
142 $ok && $msg[0] =~ /\A\s*(\S+)/
150 return ${*$self}{'net_smtp_esmtp'}->{$cmd}
151 if exists ${*$self}{'net_smtp_esmtp'}->{$cmd};
152 $self->set_status(@_)
159 my $addr = shift || "";
162 if $addr =~ /(<[^>]+>)/so;
165 $addr =~ s/(\A\s+|\s+\Z)//sog;
167 return "<" . $addr . ">";
174 my $addr = _addr(shift);
182 if(exists ${*$me}{'net_smtp_esmtp'})
184 my $esmtp = ${*$me}{'net_smtp_esmtp'};
186 if(defined($v = delete $opt{Size}))
188 if(exists $esmtp->{SIZE})
190 $opts .= sprintf " SIZE=%d", $v + 0
194 carp 'Net::SMTP::mail: SIZE option not supported by host';
198 if(defined($v = delete $opt{Return}))
200 if(exists $esmtp->{DSN})
202 $opts .= " RET=" . uc $v
206 carp 'Net::SMTP::mail: DSN option not supported by host';
210 if(defined($v = delete $opt{Bits}))
212 if(exists $esmtp->{'8BITMIME'})
214 $opts .= $v == 8 ? " BODY=8BITMIME" : " BODY=7BIT"
218 carp 'Net::SMTP::mail: 8BITMIME option not supported by host';
222 if(defined($v = delete $opt{Transaction}))
224 if(exists $esmtp->{CHECKPOINT})
226 $opts .= " TRANSID=" . _addr($v);
230 carp 'Net::SMTP::mail: CHECKPOINT option not supported by host';
234 if(defined($v = delete $opt{Envelope}))
236 if(exists $esmtp->{DSN})
238 $v =~ s/([^\041-\176]|=|\+)/sprintf "+%02x", ord($1)/sge;
243 carp 'Net::SMTP::mail: DSN option not supported by host';
247 carp 'Net::SMTP::recipient: unknown option(s) '
248 . join(" ", keys %opt)
254 carp 'Net::SMTP::mail: ESMTP not supported by host - options discarded :-(';
258 $me->_MAIL("FROM:".$addr.$opts);
261 sub send { shift->_SEND("FROM:" . _addr($_[0])) }
262 sub send_or_mail { shift->_SOML("FROM:" . _addr($_[0])) }
263 sub send_and_mail { shift->_SAML("FROM:" . _addr($_[0])) }
270 if(exists ${*$me}{'net_smtp_lastch'});
282 if(@_ && ref($_[-1]))
284 my %opt = %{pop(@_)};
287 $skip_bad = delete $opt{'SkipBad'};
289 if(exists ${*$smtp}{'net_smtp_esmtp'})
291 my $esmtp = ${*$smtp}{'net_smtp_esmtp'};
293 if(defined($v = delete $opt{Notify}))
295 if(exists $esmtp->{DSN})
297 $opts .= " NOTIFY=" . join(",",map { uc $_ } @$v)
301 carp 'Net::SMTP::recipient: DSN option not supported by host';
305 carp 'Net::SMTP::recipient: unknown option(s) '
306 . join(" ", keys %opt)
312 carp 'Net::SMTP::recipient: ESMTP not supported by host - options discarded :-(';
320 if($smtp->_RCPT("TO:" . _addr($addr) . $opts)) {
321 push(@ok,$addr) if $skip_bad;
328 return $skip_bad ? @ok : 1;
341 my $ok = $me->_DATA() && $me->datasend(@_);
343 $ok && @_ ? $me->dataend
351 $me->_EXPN(@_) ? ($me->message)
356 sub verify { shift->_VRFY(@_) }
362 $me->_HELP(@_) ? scalar $me->message
383 sub _EHLO { shift->command("EHLO", @_)->response() == CMD_OK }
384 sub _HELO { shift->command("HELO", @_)->response() == CMD_OK }
385 sub _MAIL { shift->command("MAIL", @_)->response() == CMD_OK }
386 sub _RCPT { shift->command("RCPT", @_)->response() == CMD_OK }
387 sub _SEND { shift->command("SEND", @_)->response() == CMD_OK }
388 sub _SAML { shift->command("SAML", @_)->response() == CMD_OK }
389 sub _SOML { shift->command("SOML", @_)->response() == CMD_OK }
390 sub _VRFY { shift->command("VRFY", @_)->response() == CMD_OK }
391 sub _EXPN { shift->command("EXPN", @_)->response() == CMD_OK }
392 sub _HELP { shift->command("HELP", @_)->response() == CMD_OK }
393 sub _RSET { shift->command("RSET")->response() == CMD_OK }
394 sub _NOOP { shift->command("NOOP")->response() == CMD_OK }
395 sub _QUIT { shift->command("QUIT")->response() == CMD_OK }
396 sub _DATA { shift->command("DATA")->response() == CMD_MORE }
397 sub _TURN { shift->unsupported(@_); }
398 sub _ETRN { shift->command("ETRN", @_)->response() == CMD_OK }
399 sub _AUTH { shift->command("AUTH", @_)->response() == CMD_OK }
407 Net::SMTP - Simple Mail Transfer Protocol Client
414 $smtp = Net::SMTP->new('mailhost');
415 $smtp = Net::SMTP->new('mailhost', Timeout => 60);
419 This module implements a client interface to the SMTP and ESMTP
420 protocol, enabling a perl5 application to talk to SMTP servers. This
421 documentation assumes that you are familiar with the concepts of the
422 SMTP protocol described in RFC821.
424 A new Net::SMTP object must be created with the I<new> method. Once
425 this has been done, all SMTP commands are accessed through this object.
427 The Net::SMTP class is a subclass of Net::Cmd and IO::Socket::INET.
431 This example prints the mail domain name of the SMTP server known as mailhost:
433 #!/usr/local/bin/perl -w
437 $smtp = Net::SMTP->new('mailhost');
438 print $smtp->domain,"\n";
441 This example sends a small message to the postmaster at the SMTP server
444 #!/usr/local/bin/perl -w
448 $smtp = Net::SMTP->new('mailhost');
450 $smtp->mail($ENV{USER});
451 $smtp->to('postmaster');
454 $smtp->datasend("To: postmaster\n");
455 $smtp->datasend("\n");
456 $smtp->datasend("A simple test message\n");
465 =item new Net::SMTP [ HOST, ] [ OPTIONS ]
467 This is the constructor for a new Net::SMTP object. C<HOST> is the
468 name of the remote host to which an SMTP connection is required.
470 If C<HOST> is not given, then the C<SMTP_Host> specified in C<Net::Config>
473 C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
474 Possible options are:
476 B<Hello> - SMTP requires that you identify yourself. This option
477 specifies a string to pass as your mail domain. If not
478 given a guess will be taken.
480 B<Timeout> - Maximum time, in seconds, to wait for a response from the
481 SMTP server (default: 120)
483 B<Debug> - Enable debugging information
489 $smtp = Net::SMTP->new('mailhost',
490 Hello => 'my.mail.domain'
499 Unless otherwise stated all methods return either a I<true> or I<false>
500 value, with I<true> meaning that the operation was a success. When a method
501 states that it returns a value, failure will be returned as I<undef> or an
508 Returns the banner message which the server replied with when the
509 initial connection was made.
513 Returns the domain that the remote SMTP server identified itself as during
516 =item hello ( DOMAIN )
518 Tell the remote server the mail domain which you are in using the EHLO
519 command (or HELO if EHLO fails). Since this method is invoked
520 automatically when the Net::SMTP object is constructed the user should
521 normally not have to call it manually.
523 =item etrn ( DOMAIN )
525 Request a queue run for the DOMAIN given.
527 =item auth ( USERNAME, PASSWORD )
529 Attempt SASL authentication. At this time only the PLAIN mechanism is supported.
531 At some point in the future support for using Authen::SASL will be added
533 =item mail ( ADDRESS [, OPTIONS] )
535 =item send ( ADDRESS )
537 =item send_or_mail ( ADDRESS )
539 =item send_and_mail ( ADDRESS )
541 Send the appropriate command to the server MAIL, SEND, SOML or SAML. C<ADDRESS>
542 is the address of the sender. This initiates the sending of a message. The
543 method C<recipient> should be called for each address that the message is to
546 The C<mail> method can some additional ESMTP OPTIONS which is passed
547 in hash like fashion, using key and value pairs. Possible options are:
552 Transaction => <ADDRESS>
558 Reset the status of the server. This may be called after a message has been
559 initiated, but before any data has been sent, to cancel the sending of the
562 =item recipient ( ADDRESS [, ADDRESS [ ...]] [, OPTIONS ] )
564 Notify the server that the current message should be sent to all of the
565 addresses given. Each address is sent as a separate command to the server.
566 Should the sending of any address result in a failure then the
567 process is aborted and a I<false> value is returned. It is up to the
568 user to call C<reset> if they so desire.
570 The C<recipient> method can some additional OPTIONS which is passed
571 in hash like fashion, using key and value pairs. Possible options are:
574 SkipBad => ignore bad addresses
576 If C<SkipBad> is true the C<recipient> will not return an error when a
577 bad address is encountered and it will return an array of addresses
580 $smtp->recipient($recipient1,$recipient2); # Good
581 $smtp->recipient($recipient1,$recipient2, { SkipBad => 1 }); # Good
582 $smtp->recipient("$recipient,$recipient2"); # BAD
584 =item to ( ADDRESS [, ADDRESS [...]] )
586 =item cc ( ADDRESS [, ADDRESS [...]] )
588 =item bcc ( ADDRESS [, ADDRESS [...]] )
590 Synonyms for C<recipient>.
592 =item data ( [ DATA ] )
594 Initiate the sending of the data from the current message.
596 C<DATA> may be a reference to a list or a list. If specified the contents
597 of C<DATA> and a termination string C<".\r\n"> is sent to the server. And the
598 result will be true if the data was accepted.
600 If C<DATA> is not specified then the result will indicate that the server
601 wishes the data to be sent. The data must then be sent using the C<datasend>
602 and C<dataend> methods described in L<Net::Cmd>.
604 =item expand ( ADDRESS )
606 Request the server to expand the given address Returns an array
607 which contains the text read from the server.
609 =item verify ( ADDRESS )
611 Verify that C<ADDRESS> is a legitimate mailing address.
613 =item help ( [ $subject ] )
615 Request help text from the server. Returns the text or undef upon failure
619 Send the QUIT command to the remote SMTP server and close the socket connection.
629 Graham Barr <gbarr@pobox.com>
633 Copyright (c) 1995-1997 Graham Barr. All rights reserved.
634 This program is free software; you can redistribute it and/or modify
635 it under the same terms as Perl itself.
639 I<$Id: //depot/libnet/Net/SMTP.pm#20 $>