3 # Copyright (c) 1995-2004 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);
21 @ISA = qw(Net::Cmd IO::Socket::INET);
26 my $type = ref($self) || $self;
33 $host=delete $arg{Host};
35 my $hosts = defined $host ? $host : $NetConfig{smtp_hosts};
39 foreach $h (@{ref($hosts) ? $hosts : [ $hosts ]})
41 $obj = $type->SUPER::new(PeerAddr => ($host = $h),
42 PeerPort => $arg{Port} || 'smtp(25)',
43 LocalAddr => $arg{LocalAddr},
44 LocalPort => $arg{LocalPort},
46 Timeout => defined $arg{Timeout}
57 $obj->debug(exists $arg{Debug} ? $arg{Debug} : undef);
59 unless ($obj->response() == CMD_OK)
65 ${*$obj}{'net_smtp_exact_addr'} = $arg{ExactAddresses};
66 ${*$obj}{'net_smtp_host'} = $host;
68 (${*$obj}{'net_smtp_banner'}) = $obj->message;
69 (${*$obj}{'net_smtp_domain'}) = $obj->message =~ /\A\s*(\S+)/;
71 unless($obj->hello($arg{Hello} || ""))
82 ${*$me}{'net_smtp_host'};
86 ## User interface methods
93 return ${*$me}{'net_smtp_banner'} || undef;
100 return ${*$me}{'net_smtp_domain'} || undef;
105 defined($self->supports('ETRN',500,["Command unknown: 'ETRN'"])) &&
110 my ($self, $username, $password) = @_;
112 require MIME::Base64;
113 require Authen::SASL;
115 my $mechanisms = $self->supports('AUTH',500,["Command unknown: 'AUTH'"]);
116 return unless defined $mechanisms;
120 if (ref($username) and UNIVERSAL::isa($username,'Authen::SASL')) {
122 $sasl->mechanism($mechanisms);
125 die "auth(username, password)" if not length $username;
126 $sasl = Authen::SASL->new(mechanism=> $mechanisms,
127 callback => { user => $username,
129 authname => $username,
133 # We should probably allow the user to pass the host, but I don't
134 # currently know and SASL mechanisms that are used by smtp that need it
135 my $client = $sasl->client_new('smtp',${*$self}{'net_smtp_host'},0);
136 my $str = $client->client_start;
137 # We dont support sasl mechanisms that encrypt the socket traffic.
138 # todo that we would really need to change the ISA hierarchy
139 # so we dont inherit from IO::Socket, but instead hold it in an attribute
141 my @cmd = ("AUTH", $client->mechanism);
144 push @cmd, MIME::Base64::encode_base64($str,'')
145 if defined $str and length $str;
147 while (($code = $self->command(@cmd)->response()) == CMD_MORE) {
148 @cmd = (MIME::Base64::encode_base64(
149 $client->client_step(
150 MIME::Base64::decode_base64(
163 my $domain = shift || "localhost.localdomain";
164 my $ok = $me->_EHLO($domain);
165 my @msg = $me->message;
169 my $h = ${*$me}{'net_smtp_esmtp'} = {};
173 if $ln =~ /(\w+)\b[= \t]*([^\n]*)/;
176 elsif($me->status == CMD_ERROR)
179 if $ok = $me->_HELO($domain);
182 return undef unless $ok;
184 $msg[0] =~ /\A\s*(\S+)/;
191 return ${*$self}{'net_smtp_esmtp'}->{$cmd}
192 if exists ${*$self}{'net_smtp_esmtp'}->{$cmd};
193 $self->set_status(@_)
201 $addr = "" unless defined $addr;
203 if (${*$self}{'net_smtp_exact_addr'}) {
204 return $1 if $addr =~ /^\s*(<.*>)\s*$/s;
207 return $1 if $addr =~ /(<[^>]*>)/;
208 $addr =~ s/^\s+|\s+$//sg;
217 my $addr = _addr($me, shift);
225 if(exists ${*$me}{'net_smtp_esmtp'})
227 my $esmtp = ${*$me}{'net_smtp_esmtp'};
229 if(defined($v = delete $opt{Size}))
231 if(exists $esmtp->{SIZE})
233 $opts .= sprintf " SIZE=%d", $v + 0
237 carp 'Net::SMTP::mail: SIZE option not supported by host';
241 if(defined($v = delete $opt{Return}))
243 if(exists $esmtp->{DSN})
245 $opts .= " RET=" . ((uc($v) eq "FULL") ? "FULL" : "HDRS");
249 carp 'Net::SMTP::mail: DSN option not supported by host';
253 if(defined($v = delete $opt{Bits}))
257 if(exists $esmtp->{'8BITMIME'})
259 $opts .= " BODY=8BITMIME";
263 carp 'Net::SMTP::mail: 8BITMIME option not supported by host';
266 elsif($v eq "binary")
268 if(exists $esmtp->{'BINARYMIME'} && exists $esmtp->{'CHUNKING'})
270 $opts .= " BODY=BINARYMIME";
271 ${*$me}{'net_smtp_chunking'} = 1;
275 carp 'Net::SMTP::mail: BINARYMIME option not supported by host';
278 elsif(exists $esmtp->{'8BITMIME'} or exists $esmtp->{'BINARYMIME'})
280 $opts .= " BODY=7BIT";
284 carp 'Net::SMTP::mail: 8BITMIME and BINARYMIME options not supported by host';
288 if(defined($v = delete $opt{Transaction}))
290 if(exists $esmtp->{CHECKPOINT})
292 $opts .= " TRANSID=" . _addr($me, $v);
296 carp 'Net::SMTP::mail: CHECKPOINT option not supported by host';
300 if(defined($v = delete $opt{Envelope}))
302 if(exists $esmtp->{DSN})
304 $v =~ s/([^\041-\176]|=|\+)/sprintf "+%02x", ord($1)/sge;
309 carp 'Net::SMTP::mail: DSN option not supported by host';
313 if(defined($v = delete $opt{XVERP}))
315 if(exists $esmtp->{'XVERP'})
321 carp 'Net::SMTP::mail: XVERP option not supported by host';
325 carp 'Net::SMTP::recipient: unknown option(s) '
326 . join(" ", keys %opt)
332 carp 'Net::SMTP::mail: ESMTP not supported by host - options discarded :-(';
336 $me->_MAIL("FROM:".$addr.$opts);
339 sub send { my $me = shift; $me->_SEND("FROM:" . _addr($me, $_[0])) }
340 sub send_or_mail { my $me = shift; $me->_SOML("FROM:" . _addr($me, $_[0])) }
341 sub send_and_mail { my $me = shift; $me->_SAML("FROM:" . _addr($me, $_[0])) }
348 if(exists ${*$me}{'net_smtp_lastch'});
360 if(@_ && ref($_[-1]))
362 my %opt = %{pop(@_)};
365 $skip_bad = delete $opt{'SkipBad'};
367 if(exists ${*$smtp}{'net_smtp_esmtp'})
369 my $esmtp = ${*$smtp}{'net_smtp_esmtp'};
371 if(defined($v = delete $opt{Notify}))
373 if(exists $esmtp->{DSN})
375 $opts .= " NOTIFY=" . join(",",map { uc $_ } @$v)
379 carp 'Net::SMTP::recipient: DSN option not supported by host';
383 carp 'Net::SMTP::recipient: unknown option(s) '
384 . join(" ", keys %opt)
390 carp 'Net::SMTP::recipient: ESMTP not supported by host - options discarded :-(';
398 if($smtp->_RCPT("TO:" . _addr($smtp, $addr) . $opts)) {
399 push(@ok,$addr) if $skip_bad;
406 return $skip_bad ? @ok : 1;
419 if(exists ${*$me}{'net_smtp_chunking'})
421 carp 'Net::SMTP::data: CHUNKING extension in use, must call bdat instead';
425 my $ok = $me->_DATA() && $me->datasend(@_);
427 $ok && @_ ? $me->dataend
436 if(exists ${*$me}{'net_smtp_chunking'})
440 $me->_BDAT(length $data) && $me->rawdatasend($data) &&
441 $me->response() == CMD_OK;
445 carp 'Net::SMTP::bdat: CHUNKING extension is not in use, call data instead';
453 if(exists ${*$me}{'net_smtp_chunking'})
457 $me->_BDAT(length $data, "LAST") && $me->rawdatasend($data) &&
458 $me->response() == CMD_OK;
462 carp 'Net::SMTP::bdat: CHUNKING extension is not in use, call data instead';
468 return unless $me->_DATA();
476 $me->_EXPN(@_) ? ($me->message)
481 sub verify { shift->_VRFY(@_) }
487 $me->_HELP(@_) ? scalar $me->message
508 sub _EHLO { shift->command("EHLO", @_)->response() == CMD_OK }
509 sub _HELO { shift->command("HELO", @_)->response() == CMD_OK }
510 sub _MAIL { shift->command("MAIL", @_)->response() == CMD_OK }
511 sub _RCPT { shift->command("RCPT", @_)->response() == CMD_OK }
512 sub _SEND { shift->command("SEND", @_)->response() == CMD_OK }
513 sub _SAML { shift->command("SAML", @_)->response() == CMD_OK }
514 sub _SOML { shift->command("SOML", @_)->response() == CMD_OK }
515 sub _VRFY { shift->command("VRFY", @_)->response() == CMD_OK }
516 sub _EXPN { shift->command("EXPN", @_)->response() == CMD_OK }
517 sub _HELP { shift->command("HELP", @_)->response() == CMD_OK }
518 sub _RSET { shift->command("RSET")->response() == CMD_OK }
519 sub _NOOP { shift->command("NOOP")->response() == CMD_OK }
520 sub _QUIT { shift->command("QUIT")->response() == CMD_OK }
521 sub _DATA { shift->command("DATA")->response() == CMD_MORE }
522 sub _BDAT { shift->command("BDAT", @_) }
523 sub _TURN { shift->unsupported(@_); }
524 sub _ETRN { shift->command("ETRN", @_)->response() == CMD_OK }
525 sub _AUTH { shift->command("AUTH", @_)->response() == CMD_OK }
533 Net::SMTP - Simple Mail Transfer Protocol Client
540 $smtp = Net::SMTP->new('mailhost');
541 $smtp = Net::SMTP->new('mailhost', Timeout => 60);
545 This module implements a client interface to the SMTP and ESMTP
546 protocol, enabling a perl5 application to talk to SMTP servers. This
547 documentation assumes that you are familiar with the concepts of the
548 SMTP protocol described in RFC821.
550 A new Net::SMTP object must be created with the I<new> method. Once
551 this has been done, all SMTP commands are accessed through this object.
553 The Net::SMTP class is a subclass of Net::Cmd and IO::Socket::INET.
557 This example prints the mail domain name of the SMTP server known as mailhost:
559 #!/usr/local/bin/perl -w
563 $smtp = Net::SMTP->new('mailhost');
564 print $smtp->domain,"\n";
567 This example sends a small message to the postmaster at the SMTP server
570 #!/usr/local/bin/perl -w
574 $smtp = Net::SMTP->new('mailhost');
576 $smtp->mail($ENV{USER});
577 $smtp->to('postmaster');
580 $smtp->datasend("To: postmaster\n");
581 $smtp->datasend("\n");
582 $smtp->datasend("A simple test message\n");
591 =item new ( [ HOST ] [, OPTIONS ] )
593 This is the constructor for a new Net::SMTP object. C<HOST> is the
594 name of the remote host to which an SMTP connection is required.
596 C<HOST> is optional. If C<HOST> is not given then it may instead be
597 passed as the C<Host> option described below. If neither is given then
598 the C<SMTP_Hosts> specified in C<Net::Config> will be used.
600 C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
601 Possible options are:
603 B<Hello> - SMTP requires that you identify yourself. This option
604 specifies a string to pass as your mail domain. If not given localhost.localdomain
607 B<Host> - SMTP host to connect to. It may be a single scalar, as defined for
608 the C<PeerAddr> option in L<IO::Socket::INET>, or a reference to
609 an array with hosts to try in turn. The L</host> method will return the value
610 which was used to connect to the host.
612 B<LocalAddr> and B<LocalPort> - These parameters are passed directly
613 to IO::Socket to allow binding the socket to a local port.
615 B<Timeout> - Maximum time, in seconds, to wait for a response from the
616 SMTP server (default: 120)
618 B<ExactAddresses> - If true the all ADDRESS arguments must be as
619 defined by C<addr-spec> in RFC2822. If not given, or false, then
620 Net::SMTP will attempt to extract the address from the value passed.
622 B<Debug> - Enable debugging information
628 $smtp = Net::SMTP->new('mailhost',
629 Hello => 'my.mail.domain'
635 $smtp = Net::SMTP->new(
637 Hello => 'my.mail.domain'
642 # Connect to the default server from Net::config
643 $smtp = Net::SMTP->new(
644 Hello => 'my.mail.domain'
652 Unless otherwise stated all methods return either a I<true> or I<false>
653 value, with I<true> meaning that the operation was a success. When a method
654 states that it returns a value, failure will be returned as I<undef> or an
661 Returns the banner message which the server replied with when the
662 initial connection was made.
666 Returns the domain that the remote SMTP server identified itself as during
669 =item hello ( DOMAIN )
671 Tell the remote server the mail domain which you are in using the EHLO
672 command (or HELO if EHLO fails). Since this method is invoked
673 automatically when the Net::SMTP object is constructed the user should
674 normally not have to call it manually.
678 Returns the value used by the constructor, and passed to IO::Socket::INET,
679 to connect to the host.
681 =item etrn ( DOMAIN )
683 Request a queue run for the DOMAIN given.
685 =item auth ( USERNAME, PASSWORD )
687 Attempt SASL authentication.
689 =item mail ( ADDRESS [, OPTIONS] )
691 =item send ( ADDRESS )
693 =item send_or_mail ( ADDRESS )
695 =item send_and_mail ( ADDRESS )
697 Send the appropriate command to the server MAIL, SEND, SOML or SAML. C<ADDRESS>
698 is the address of the sender. This initiates the sending of a message. The
699 method C<recipient> should be called for each address that the message is to
702 The C<mail> method can some additional ESMTP OPTIONS which is passed
703 in hash like fashion, using key and value pairs. Possible options are:
706 Return => "FULL" | "HDRS"
707 Bits => "7" | "8" | "binary"
708 Transaction => <ADDRESS>
712 The C<Return> and C<Envelope> parameters are used for DSN (Delivery
713 Status Notification).
717 Reset the status of the server. This may be called after a message has been
718 initiated, but before any data has been sent, to cancel the sending of the
721 =item recipient ( ADDRESS [, ADDRESS, [...]] [, OPTIONS ] )
723 Notify the server that the current message should be sent to all of the
724 addresses given. Each address is sent as a separate command to the server.
725 Should the sending of any address result in a failure then the process is
726 aborted and a I<false> value is returned. It is up to the user to call
727 C<reset> if they so desire.
729 The C<recipient> method can also pass additional case-sensitive OPTIONS as an
730 anonymous hash using key and value pairs. Possible options are:
732 Notify => ['NEVER'] or ['SUCCESS','FAILURE','DELAY'] (see below)
733 SkipBad => 1 (to ignore bad addresses)
735 If C<SkipBad> is true the C<recipient> will not return an error when a bad
736 address is encountered and it will return an array of addresses that did
739 $smtp->recipient($recipient1,$recipient2); # Good
740 $smtp->recipient($recipient1,$recipient2, { SkipBad => 1 }); # Good
741 $smtp->recipient($recipient1,$recipient2, { Notify => ['FAILURE','DELAY'], SkipBad => 1 }); # Good
742 @goodrecips=$smtp->recipient(@recipients, { Notify => ['FAILURE'], SkipBad => 1 }); # Good
743 $smtp->recipient("$recipient,$recipient2"); # BAD
745 Notify is used to request Delivery Status Notifications (DSNs), but your
746 SMTP/ESMTP service may not respect this request depending upon its version and
747 your site's SMTP configuration.
749 Leaving out the Notify option usually defaults an SMTP service to its default
750 behavior equivalent to ['FAILURE'] notifications only, but again this may be
751 dependent upon your site's SMTP configuration.
753 The NEVER keyword must appear by itself if used within the Notify option and "requests
754 that a DSN not be returned to the sender under any conditions."
756 {Notify => ['NEVER']}
758 $smtp->recipient(@recipients, { Notify => ['NEVER'], SkipBad => 1 }); # Good
760 You may use any combination of these three values 'SUCCESS','FAILURE','DELAY' in
761 the anonymous array reference as defined by RFC3461 (see http://rfc.net/rfc3461.html
762 for more information. Note: quotations in this topic from same.).
764 A Notify parameter of 'SUCCESS' or 'FAILURE' "requests that a DSN be issued on
765 successful delivery or delivery failure, respectively."
767 A Notify parameter of 'DELAY' "indicates the sender's willingness to receive
768 delayed DSNs. Delayed DSNs may be issued if delivery of a message has been
769 delayed for an unusual amount of time (as determined by the Message Transfer
770 Agent (MTA) at which the message is delayed), but the final delivery status
771 (whether successful or failure) cannot be determined. The absence of the DELAY
772 keyword in a NOTIFY parameter requests that a "delayed" DSN NOT be issued under
775 {Notify => ['SUCCESS','FAILURE','DELAY']}
777 $smtp->recipient(@recipients, { Notify => ['FAILURE','DELAY'], SkipBad => 1 }); # Good
779 =item to ( ADDRESS [, ADDRESS [...]] )
781 =item cc ( ADDRESS [, ADDRESS [...]] )
783 =item bcc ( ADDRESS [, ADDRESS [...]] )
785 Synonyms for C<recipient>.
787 =item data ( [ DATA ] )
789 Initiate the sending of the data from the current message.
791 C<DATA> may be a reference to a list or a list. If specified the contents
792 of C<DATA> and a termination string C<".\r\n"> is sent to the server. And the
793 result will be true if the data was accepted.
795 If C<DATA> is not specified then the result will indicate that the server
796 wishes the data to be sent. The data must then be sent using the C<datasend>
797 and C<dataend> methods described in L<Net::Cmd>.
799 =item expand ( ADDRESS )
801 Request the server to expand the given address Returns an array
802 which contains the text read from the server.
804 =item verify ( ADDRESS )
806 Verify that C<ADDRESS> is a legitimate mailing address.
808 Most sites usually disable this feature in their SMTP service configuration.
809 Use "Debug => 1" option under new() to see if disabled.
811 =item help ( [ $subject ] )
813 Request help text from the server. Returns the text or undef upon failure
817 Send the QUIT command to the remote SMTP server and close the socket connection.
823 Net::SMTP attempts to DWIM with addresses that are passed. For
824 example an application might extract The From: line from an email
825 and pass that to mail(). While this may work, it is not reccomended.
826 The application should really use a module like L<Mail::Address>
827 to extract the mail address and pass that.
829 If C<ExactAddresses> is passed to the contructor, then addresses
830 should be a valid rfc2821-quoted address, although Net::SMTP will
831 accept accept the address surrounded by angle brackets.
833 funny user@domain WRONG
834 "funny user"@domain RIGHT, recommended
835 <"funny user"@domain> OK
843 Graham Barr <gbarr@pobox.com>
847 Copyright (c) 1995-2004 Graham Barr. All rights reserved.
848 This program is free software; you can redistribute it and/or modify
849 it under the same terms as Perl itself.