net::smtp_auth(3pm) [debian man page]

SMTP_auth(3pm)						User Contributed Perl Documentation					    SMTP_auth(3pm)

NAME

       Net::SMTP_auth - Simple Mail Transfer Protocol Client with AUTHentication

SYNOPSIS

	   use Net::SMTP_auth;

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

DESCRIPTION

       This module implements a client interface to the SMTP and ESMTP protocol AUTH service extension, enabling a perl5 application to talk to
       and authenticate against SMTP servers. This documentation assumes that you are familiar with the concepts of the SMTP protocol described in
       RFC821 and with the AUTH service extension described in RFC2554.

       A new Net::SMTP_auth object must be created with the new method. Once this has been done, all SMTP commands are accessed through this
       object.

       The Net::SMTP_auth class is a subclass of Net::SMTP, which itself is a subclass of Net::Cmd and IO::Socket::INET.

EXAMPLES

       This example authenticates via CRAM-MD5 and sends a small message to the postmaster at the SMTP server known as mailhost:

	   #!/usr/bin/perl -w

	   use Net::SMTP_auth;

	   $smtp = Net::SMTP_auth->new('mailhost');
	   $smtp->auth('CRAM-MD5', 'user', 'password');

	   $smtp->mail($ENV{USER});
	   $smtp->to('postmaster');

	   $smtp->data();
	   $smtp->datasend("To: postmaster
");
	   $smtp->datasend("
");
	   $smtp->datasend("A simple test message
");
	   $smtp->dataend();

	   $smtp->quit;

CONSTRUCTOR

       new Net::SMTP_auth [ HOST, ] [ OPTIONS ]
	   This is the constructor for a new Net::SMTP_auth object. It is taken from Net::SMTP as all other methods (except auth and auth_types)
	   are, too.

METHODS

       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.

	   auth_types ()
	       Returns the AUTH methods supported by the server as an array or in a space separated string. This string is exacly the line given
	       by the SMTP server after the "EHLO" command containing the keyword "AUTH".

	   auth ( AUTH, USER, PASSWORD )
	       Authenticates the user "USER" via the authentication method "AUTH" and the password "PASSWORD". Returns true if successful and
	       false if the authentication failed. Remember that the connection is not closed if the authentication fails. You may issue a differ-
	       ent authentication attempt. If you once are successfully authenticated, you cannot send the "AUTH" command again.

	       The "AUTH" method "NTLM" is supported via Authen::NTLM (thanks to James Fryman).

SEE ALSO

       Net::SMTP and Net::Cmd

AUTHOR

       Alex Pleiner <alex@zeitform.de>, zeitform Internet Dienste.  Thanks to Graham Barr <gbarr@pobox.com> for Net::SMTP.  NTLM authentication
       code provided by James Fryman <jfryman@gmail.com>

COPYRIGHT

       Copyright (c) 2001, 2003, 2006 zeitform Internet Dienste. All rights reserved.  This program is free software; you can redistribute it
       and/or modify it under the same terms as Perl itself.

perl v5.8.8							    2006-01-13							    SMTP_auth(3pm)

Net::SMTP::TLS(3pm)					User Contributed Perl Documentation				       Net::SMTP::TLS(3pm)

NAME

       Net::SMTP::TLS - An SMTP client supporting TLS and AUTH

VERSION

       Version 0.12

SYNOPSIS

	use Net::SMTP::TLS;
	my $mailer = new Net::SMTP::TLS(
	       'your.mail.host',
	       Hello   =>      'some.host.name',
	       Port    =>      25, #redundant
	       User    =>      'emailguy',
	       Password=>      's3cr3t');
	$mailer->mail('emailguy@your.mail.host');
	$mailer->to('someonecool@somewhere.else');
	$mailer->data;
	$mailer->datasend("Sent thru TLS!");
	$mailer->dataend;
	$mailer->quit;

DESCRIPTION

       Net::SMTP::TLS is a TLS and AUTH capable SMTP client which offers an interface that users will find familiar from Net::SMTP. Net::SMTP::TLS
       implements a subset of the methods provided by that module, but certainly not (yet) a complete mirror image of that API.

       The methods supported by Net::SMTP::TLS are used in the above example. Though self explanatory for the most part, please see the perldoc
       for Net::SMTP if you are unclear.

       The differences in the methods provided are as follows:

	   The mail method does not take the options list taken by Net::SMTP

	   The to method also does not take options, and is the only method available to set the recipient (unlike the many synonyms provided by
	   Net::SMTP).

	   The constructor takes a limited number of Net::SMTP's parameters. The constructor for Net::SMTP::TLS takes the following (in addition
	   to the hostname of the mail server, which must be the first parameter and is not explicitly named):

	       NoTLS - In the unlikely event that you need to use this class to perform non-TLS SMTP (you ought to be using Net::SMTP itself for
	       that...), this will turn off TLS when supplied with a true value. This will most often cause an error related to authentication
	       when used on a server that requires TLS

	       Hello - hostname used in the EHLO command

	       Port - port to connect to the SMTP service (defaults to 25)

	       Timeout - Timeout for inital socket connection (defaults to 5, passed directly to IO::Socket::INET)

	       User - username for SMTP AUTH

	       Password - password for SMTP AUTH

TLS and AUTHentication
       During construction of an Net::SMTP::TLS instance, the full login process will occur. This involves first sending EHLO to the server, then
       initiating a TLS session through STARTTLS. Once this is complete, the module will attempt to login using the credentials supplied by the
       constructor, if such credentials have been supplied.

       The AUTH method will depend on the features returned by the server after the EHLO command. Based on that, CRAM-MD5 will be used if
       available, followed by LOGIN, followed by PLAIN. Please note that LOGIN is the only method of authentication that has been tested. CRAM-MD5
       and PLAIN login functionality was taken directly from the script mentioned in the acknowledgements section, however, I have not tested them
       personally.

ERROR HANDLING

       This module will croak in the event of an SMTP error. Should you wish to handle this gracefully in your application, you may wrap your mail
       transmission in an eval {} block and check $@ afterward.

ACKNOWLEDGEMENTS

       This code was blatantly plagiarized from Michal Ludvig's smtp-client.pl script. See <http://www.logix.cz/michal/devel/smtp> for his
       excellent work.

AUTHOR

       Alexander Christian Westholm, awestholm at verizon dawt net

       Improvements courtesy of Tomek Zielinski

perl v5.10.0							    2006-01-17						       Net::SMTP::TLS(3pm)