MAN page from Old RedHat 6.X libnet-1.0606-1.i386.rpm

Net::SMTP

Section: User Contributed Perl Documentation (3)
Updated: perl 5.005, patch 03
Index

NAME

Net::SMTP - Simple Mail Transfer Protocol Client

SYNOPSIS

    use Net::SMTP;        # Constructors    $smtp = Net::SMTP->new('mailhost');    $smtp = Net::SMTP->new('mailhost', Timeout => 60);

DESCRIPTION

This module implements a client interface to the SMTP and ESMTPprotocol, enabling a perl5 application to talk to SMTP servers. Thisdocumentation assumes that you are familiar with the concepts of theSMTP protocol described in RFC821.

A new Net::SMTP object must be created with the new method. Oncethis 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:

    #!/usr/bin/perl -w        use Net::SMTP;        $smtp = Net::SMTP->new('mailhost');    print $smtp->domain,"\n";    $smtp->quit;

This example sends a small message to the postmaster at the SMTP serverknown as mailhost:

    #!/usr/bin/perl -w        use Net::SMTP;        $smtp = Net::SMTP->new('mailhost');        $smtp->mail($ENV{USER});    $smtp->to('postmaster');        $smtp->data();    $smtp->datasend("To: postmaster\n");    $smtp->datasend("\n");    $smtp->datasend("A simple test message\n");    $smtp->dataend();        $smtp->quit;

CONSTRUCTOR

new Net::SMTP [ HOST, ] [ OPTIONS ]

This is the constructor for a new Net::SMTP object. HOST is thename of the remote host to which a SMTP connection is required.

If HOST is not given, then the SMTP_Host specified in Net::Configwill be used.

OPTIONS are passed in a hash like fashion, using key and value pairs.Possible options are:

Hello - SMTP requires that you identify yourself. This optionspecifies a string to pass as your mail domain. If notgiven a guess will be taken.

Timeout - Maximum time, in seconds, to wait for a response from theSMTP server (default: 120)

Debug - Enable debugging information

Example:

    $smtp = Net::SMTP->new('mailhost',                           Hello => 'my.mail.domain'                           Timeout => 30,                           Debug   => 1,                          );

METHODS

Unless otherwise stated all methods return either a true or falsevalue, with true meaning that the operation was a success. When a methodstates that it returns a value, failure will be returned as undef or anempty list.

banner ()

Returns the banner message which the server replied with when theinitial connection was made.

domain ()

Returns the domain that the remote SMTP server identified itself as duringconnection.

hello ( DOMAIN )

Tell the remote server the mail domain which you are in using the EHLOcommand (or HELO if EHLO fails). Since this method is invokedautomatically when the Net::SMTP object is constructed the user shouldnormally not have to call it manually.

etrn ( DOMAIN )

Request a queue run for the DOMAIN given.

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. ADDRESSis the address of the sender. This initiates the sending of a message. Themethod recipient should be called for each address that the message is tobe sent to.

The mail method can some additional ESMTP OPTIONS which is passedin hash like fashion, using key and value pairs. Possible options are:

 Size        => <bytes> Return      => <???> Bits        => "7" | "8" Transaction => <ADDRESS> Envelope    => <ENVID>

reset ()

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 themessage.

recipient ( ADDRESS [, ADDRESS [ ...]] )

Notify the server that the current message should be sent to all of theaddresses given. Each address is sent as a separate command to the server.Should the sending of any address result in a failure then theprocess is aborted and a false value is returned. It is up to theuser to call reset if they so desire.

to ( ADDRESS [, ADDRESS [...]] )

A synonym 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 contentsof DATA and a termination string ".\r\n" is sent to the server. And theresult will be true if the data was accepted.

If DATA is not specified then the result will indicate that the serverwishes the data to be sent. The data must then be sent using the datasendand dataend methods described in the Net::Cmd manpage.

expand ( ADDRESS )

Request the server to expand the given address Returns an arraywhich 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.

AUTHOR

Graham Barr <gbarrAATTpobox.com>

COPYRIGHT

This document was created byman2html,using the manual pages.