Chip 2000 May

home *** CD-ROM | disk | FTP | other *** search

/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _73c5de422259431f4e0bd5be07f24de4 < prev next >

Wrap

Text File | 2000-03-23 | 9.0 KB | 250 lines

<HTML> <HEAD> <TITLE>Net::SMTP - Simple Mail Transfer Protocol Client</TITLE> <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css"> <LINK REV="made" HREF="mailto:"> </HEAD> <BODY> <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%> <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc"> Net::SMTP - Simple Mail Transfer Protocol Client </TD></TR> </TABLE> <A NAME="__index__"></A>  <UL> <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI> <LI><A HREF="#synopsis">SYNOPSIS</A></LI> <LI><A HREF="#description">DESCRIPTION</A></LI> <LI><A HREF="#examples">EXAMPLES</A></LI> <LI><A HREF="#constructor">CONSTRUCTOR</A></LI> <LI><A HREF="#methods">METHODS</A></LI> <LI><A HREF="#see also">SEE ALSO</A></LI> <LI><A HREF="#author">AUTHOR</A></LI> <LI><A HREF="#copyright">COPYRIGHT</A></LI> </UL>  <HR> <H1><A NAME="name">NAME</A></H1> Net::SMTP - Simple Mail Transfer Protocol Client <HR> <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1> <UL> <LI>Linux</LI> <LI>Solaris</LI> <LI>Windows</LI> </UL> <HR> <H1><A NAME="synopsis">SYNOPSIS</A></H1> <PRE> use Net::SMTP; </PRE> <PRE> # Constructors $smtp = Net::SMTP->new('mailhost'); $smtp = Net::SMTP->new('mailhost', Timeout => 60);</PRE> <HR> <H1><A NAME="description">DESCRIPTION</A></H1> 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. <HR> <H1><A NAME="examples">EXAMPLES</A></H1> This example prints the mail domain name of the SMTP server known as mailhost: <PRE> #!/usr/local/bin/perl -w </PRE> <PRE> use Net::SMTP;</PRE> <PRE> $smtp = Net::SMTP->new('mailhost'); print $smtp->domain,"\n"; $smtp->quit;</PRE> This example sends a small message to the postmaster at the SMTP server known as mailhost: <PRE> #!/usr/local/bin/perl -w </PRE> <PRE> use Net::SMTP;</PRE> <PRE> $smtp = Net::SMTP->new('mailhost');</PRE> <PRE> $smtp->mail($ENV{USER}); $smtp->to('postmaster');</PRE> <PRE> $smtp->data(); $smtp->datasend("To: postmaster\n"); $smtp->datasend("\n"); $smtp->datasend("A simple test message\n"); $smtp->dataend();</PRE> <PRE> $smtp->quit;</PRE> <HR> <H1><A NAME="constructor">CONSTRUCTOR</A></H1> <DL> <DT><A NAME="item_new_Net%3A%3ASMTP_%5B_HOST%2C_%5D_%5B_OPTIONS_%5D">new Net::SMTP [ HOST, ] [ OPTIONS ]</A> <DD> This is the constructor for a new Net::SMTP object. <CODE>HOST</CODE> is the name of the remote host to which a SMTP connection is required. If <CODE>HOST</CODE> is not given, then the <CODE>SMTP_Host</CODE> specified in <CODE>Net::Config</CODE> will be used. <CODE>OPTIONS</CODE> 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. Timeout - Maximum time, in seconds, to wait for a response from the SMTP server (default: 120) Debug - Enable debugging information Example: <PRE> $smtp = Net::SMTP->new('mailhost', Hello => 'my.mail.domain' Timeout => 30, Debug => 1, );</PRE> </DL> <HR> <H1><A NAME="methods">METHODS</A></H1> 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. <DL> <DT><A NAME="item_banner">banner ()</A> <DD> Returns the banner message which the server replied with when the initial connection was made. <DT><A NAME="item_domain">domain ()</A> <DD> Returns the domain that the remote SMTP server identified itself as during connection. <DT><A NAME="item_hello">hello ( DOMAIN )</A> <DD> 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. <DT><A NAME="item_etrn">etrn ( DOMAIN )</A> <DD> Request a queue run for the DOMAIN given. <DT><A NAME="item_mail">mail ( ADDRESS [, OPTIONS] )</A> <DD> <DT><A NAME="item_send">send ( ADDRESS )</A> <DD> <DT><A NAME="item_send_or_mail">send_or_mail ( ADDRESS )</A> <DD> <DT><A NAME="item_send_and_mail">send_and_mail ( ADDRESS )</A> <DD> Send the appropriate command to the server MAIL, SEND, SOML or SAML. <CODE>ADDRESS</CODE> is the address of the sender. This initiates the sending of a message. The method <A HREF="#item_recipient"><CODE>recipient</CODE></A> should be called for each address that the message is to be sent to. The <A HREF="#item_mail"><CODE>mail</CODE></A> method can some additional ESMTP OPTIONS which is passed in hash like fashion, using key and value pairs. Possible options are: <PRE> Size => <bytes> Return => <???> Bits => "7" | "8" Transaction => <ADDRESS> Envelope => <ENVID></PRE> <DT><A NAME="item_reset">reset ()</A> <DD> 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. <DT><A NAME="item_recipient">recipient ( ADDRESS [, ADDRESS [ ...]] )</A> <DD> 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 <A HREF="#item_reset"><CODE>reset</CODE></A> if they so desire. <DT><A NAME="item_to">to ( ADDRESS [, ADDRESS [...]] )</A> <DD> A synonym for <A HREF="#item_recipient"><CODE>recipient</CODE></A>. <DT><A NAME="item_data">data ( [ DATA ] )</A> <DD> Initiate the sending of the data from the current message. <CODE>DATA</CODE> may be a reference to a list or a list. If specified the contents of <CODE>DATA</CODE> and a termination string <CODE>".\r\n"</CODE> is sent to the server. And the result will be true if the data was accepted. If <CODE>DATA</CODE> 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 <CODE>datasend</CODE> and <CODE>dataend</CODE> methods described in <A HREF="../../../site/lib/Net/Cmd.html">the Net::Cmd manpage</A>. <DT><A NAME="item_expand">expand ( ADDRESS )</A> <DD> Request the server to expand the given address Returns an array which contains the text read from the server. <DT><A NAME="item_verify">verify ( ADDRESS )</A> <DD> Verify that <CODE>ADDRESS</CODE> is a legitimate mailing address. <DT><A NAME="item_help">help ( [ $subject ] )</A> <DD> Request help text from the server. Returns the text or undef upon failure <DT><A NAME="item_quit">quit ()</A> <DD> Send the QUIT command to the remote SMTP server and close the socket connection. </DL> <HR> <H1><A NAME="see also">SEE ALSO</A></H1> <A HREF="../../../site/lib/Net/Cmd.html">the Net::Cmd manpage</A> <HR> <H1><A NAME="author">AUTHOR</A></H1> Graham Barr <<A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A>> <HR> <H1><A NAME="copyright">COPYRIGHT</A></H1> 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. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%> <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc"> Net::SMTP - Simple Mail Transfer Protocol Client </TD></TR> </TABLE> </BODY> </HTML>