The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Mail-Box-2.042
River stage one • 8 direct dependents • 8 total dependents
16 ++
/ Mail::Transport::SMTP

NAME

Mail::Transport::SMTP - transmit messages without external program

INHERITANCE

 Mail::Transport::SMTP
   is a Mail::Transport::Send
   is a Mail::Transport
   is a Mail::Reporter

SYNOPSIS

 my $sender = Mail::Transport::SMTP->new(...);
 $sender->send($message);

 $message->send(via => 'smtp');

DESCRIPTION

This module implements transport of Mail::Message objects by negotiating to the destination host directly by using the SMTP protocol, without help of sendmail, mail, or other programs on the local host.

METHODS

Constructors

Mail::Transport::SMTP->new(OPTIONS)

     Option       Defined in       Default           
 executable   L<Mail::Transport>  C<undef>          
 helo_domain                   <from Net::Config>
 hostname     L<Mail::Transport>  <from Net::Config>
 interval     L<Mail::Transport>  C<30>             
 log          L<Mail::Reporter>  C<'WARNINGS'>     
 password                      undef             
 port         L<Mail::Transport>  C<25>             
 proxy        L<Mail::Transport>  <from Net::Config>
 retry        L<Mail::Transport>  <false>           
 smtp_debug                    <false>           
 timeout                       120               
 trace        L<Mail::Reporter>  C<'WARNINGS'>     
 username                      undef             
 via          L<Mail::Transport>  C<'smtp'>

    . executable FILENAME

    . helo_domain HOST

      The fully qualified name of the sender's host (your system) which is used for the greeting message to the receiver. If not specified, Net::Config or else Net::Domain are questioned to find it. When even these do not supply a valid name, the name of the domain in the From line of the message is assumed.

    . hostname HOSTNAME|ARRAY-OF-HOSTNAMES

    . interval SECONDS

    . log LEVEL

    . password STRING

      The password to be used with the new(username) to log in to the remote server.

    . port INTEGER

    . proxy PATH

    . retry NUMBER|undef

    . smtp_debug BOOLEAN

      Simulate transmission: the SMTP protocol output will be sent to your screen.

    . timeout SECONDS

      The number of seconds to wait for a valid response from the server before failing.

    . trace LEVEL

    . username STRING

      Use SASL authentication to contact the remote SMTP server (RFC2554). This username in combination with new(password) is passed as arguments to Net::SMTP method auth. Other forms of authentication are not supported by Net::SMTP. The username can also be specified as an Authen::SASL object.

    . via CLASS|NAME

Sending mail

$obj->destinations(MESSAGE, [ADDRESS|ARRAY-OF-ADDRESSES])

$obj->putContent(MESSAGE, FILEHANDLE, OPTIONS)

$obj->send(MESSAGE, OPTIONS)

$obj->trySend(MESSAGE, OPTIONS)

    Try to send the MESSAGE once. This may fail, in which case this method will return false. In list context, the reason for failure can be caught: in list context trySend will return a list of five values:

     (success, error code, error text, error location, quit success)

    Success and quit success are booleans. The error code and -text are protocol specific codes and texts. The location tells where the problem occurred.

     Option  Defined in       Default
 from                     []     
 to                       []

    . from ADDRESS

      Your own identification. This may be fake. If not specified, it is taken from the From field in the header.

    . to ADDRESS|[ADDRESSES]

      Alternative destinations. If not specified, the To, Cc and Bcc fields of the header are used. An address is a string or a Mail::Address object.

Server connection

$obj->contactAnyServer

    Creates the connection to the SMTP server. When more than one hostname was specified, the first which accepts a connection is taken. An IO::Socket::INET object is returned.

$obj->findBinary(NAME [, DIRECTORIES])

$obj->remoteHost

$obj->retry

$obj->tryConnectTo(HOST, OPTIONS)

    Try to establish a connection to deliver SMTP to the specified HOST. The OPTIONS are passed to the new method of Net::SMTP.

Error handling

$obj->AUTOLOAD

$obj->defaultTrace([LEVEL, [LEVEL])

Mail::Transport::SMTP->defaultTrace([LEVEL, [LEVEL])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Transport::SMTP->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Transport::SMTP->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->inGlobalDestruction

DIAGNOSTICS

Error: Package $package does not implement $method.

Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package.

REFERENCES

See the Mail::Box website at http://perl.overmeer.net/mailbox/ for more details.

COPYRIGHTS

Module version 2.042. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.

Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.