This module implements a client interface to the SMTP and ESMTP
protocol, enabling a perl5 application to talk to SMTP servers. This
documentation assumes that you are familiar with the concepts of the
SMTP protocol described in RFC821.
A new Net::SMTP object must be created with the new method. Once
this has been done, all SMTP commands are accessed through this object.
The Net::SMTP class is a subclass of Net::Cmd and IO::Socket::INET.
EXAMPLES
This example prints the mail domain name of the SMTP server known as mailhost:
Unless otherwise stated all methods return either a true or false
value, with true meaning that the operation was a success. When a method
states that it returns a value, failure will be returned as undef or an
empty list.
banner ()
Returns the banner message which the server replied with when the
initial connection was made.
domain ()
Returns the domain that the remote SMTP server identified itself as during
connection.
hello ( DOMAIN )
Tell the remote server the mail domain which you are in using the EHLO
command (or HELO if EHLO fails). Since this method is invoked
automatically when the Net::SMTP object is constructed the user should
normally not have to call it manually.
etrn ( DOMAIN )
Request a queue run for the DOMAIN given.
auth ( USERNAME, PASSWORD )
Attempt SASL authentication. At this time only the PLAIN mechanism is supported.
At some point in the future support for using Authen::SASL will be added
mail ( ADDRESS [, OPTIONS] )
send ( ADDRESS )
send_or_mail ( ADDRESS )
send_and_mail ( ADDRESS )
Send the appropriate command to the server MAIL, SEND, SOML or SAML. "ADDRESS"
is the address of the sender. This initiates the sending of a message. The
method "recipient" should be called for each address that the message is to
be sent to.
The "mail" method can some additional ESMTP OPTIONS which is passed
in hash like fashion, using key and value pairs. Possible options are:
Reset the status of the server. This may be called after a message has been
initiated, but before any data has been sent, to cancel the sending of the
message.
Notify the server that the current message should be sent to all of the
addresses given. Each address is sent as a separate command to the server.
Should the sending of any address result in a failure then the
process is aborted and a false value is returned. It is up to the
user to call "reset" if they so desire.
The "recipient" method can some additional OPTIONS which is passed
in hash like fashion, using key and value pairs. Possible options are:
Notify =>
SkipBad => ignore bad addresses
If "SkipBad" is true the "recipient" will not return an error when a
bad address is encountered and it will return an array of addresses
that did succeed.
$smtp->recipient($recipient1,$recipient2); # Good
$smtp->recipient($recipient1,$recipient2, { SkipBad => 1 }); # Good
$smtp->recipient("$recipient,$recipient2"); # BAD
to ( ADDRESS [, ADDRESS [...]] )
cc ( ADDRESS [, ADDRESS [...]] )
bcc ( ADDRESS [, ADDRESS [...]] )
Synonyms for "recipient".
data ( [ DATA ] )
Initiate the sending of the data from the current message.
"DATA" may be a reference to a list or a list. If specified the contents
of "DATA" and a termination string ".\r\n" is sent to the server. And the
result will be true if the data was accepted.
If "DATA" is not specified then the result will indicate that the server
wishes the data to be sent. The data must then be sent using the "datasend"
and "dataend" methods described in Net::Cmd.
expand ( ADDRESS )
Request the server to expand the given address Returns an array
which contains the text read from the server.
verify ( ADDRESS )
Verify that "ADDRESS" is a legitimate mailing address.
help ( [ $subject ] )
Request help text from the server. Returns the text or undef upon failure
quit ()
Send the QUIT command to the remote SMTP server and close the socket connection.
Copyright (c) 1995-1997 Graham Barr. All rights reserved.
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.