Net::SMTP - Simple Mail Transfer Protocol Client |
Net::SMTP - Simple Mail Transfer Protocol Client
use Net::SMTP;
# Constructors $smtp = Net::SMTP->new('mailhost'); $smtp = Net::SMTP->new('mailhost', Timeout => 60);
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.
This example prints the mail domain name of the SMTP server known as mailhost:
#!/usr/local/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 server known as mailhost:
#!/usr/local/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;
HOST
is the
name of the remote host to which an SMTP connection is required.
If HOST
is not given, then the SMTP_Host
specified in Net::Config
will 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 option specifies a string to pass as your mail domain. If not given a guess will be taken.
LocalAddr and LocalPort - These parameters are passed directly to IO::Socket to allow binding the socket to a local port.
Timeout - Maximum time, in seconds, to wait for a response from the SMTP server (default: 120)
Debug - Enable debugging information
Example:
$smtp = Net::SMTP->new('mailhost', Hello => 'my.mail.domain' Timeout => 30, Debug => 1, );
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.
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:
Size => <bytes> Return => <???> Bits => "7" | "8" Transaction => <ADDRESS> Envelope => <ENVID>
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
recipient
.
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 the Net::Cmd manpage.
ADDRESS
is a legitimate mailing address.
All methods that accept addresses expect the address to be a valid rfc2821-quoted address, although Net::SMTP will accept accept the address surrounded by angle brackets.
funny user@domain WRONG "funny user"@domain RIGHT, recommended <"funny user"@domain> OK
Graham Barr <gbarr@pobox.com>
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.
$Id: //depot/libnet/Net/SMTP.pm#25 $
Net::SMTP - Simple Mail Transfer Protocol Client |