=encoding utf8
=head1 NAME
Mail::Transport - base class for message exchange
=head1 INHERITANCE
Mail::Transport
is a Mail::Reporter
Mail::Transport is extended by
Mail::Transport::Receive
Mail::Transport::Send
=head1 SYNOPSIS
my $message = Mail::Message->new(...);
# Some extensions implement sending:
$message->send;
$message->send(via => 'sendmail');
my $sender = Mail::Transport::SMTP->new(...);
$sender->send($message);
# Some extensions implement receiving:
my $receiver = Mail::Transport::POP3->new(...);
$message = $receiver->receive;
=head1 DESCRIPTION
Objects which extend C implement sending and/or
receiving of messages, using various protocols.
L extends this class, and offers general
functionality for send protocols, like SMTP. L
also extends this class, and offers receive method. Some transport
protocols will implement both sending and receiving.
See L.
=head1 METHODS
See L.
=head2 Constructors
See L.
=over 4
=item Mail::Transport-EB(OPTIONS)
-Option --Defined in --Default
executable undef
hostname 'localhost'
interval 30
log Mail::Reporter 'WARNINGS'
password undef
port undef
proxy undef
retry
timeout 120
trace Mail::Reporter 'WARNINGS'
username undef
via 'sendmail'
=over 2
=item executable => FILENAME
If you specify an executable, the module does not need to search the
system directories to figure-out where the client lives. Using this
decreases the flexible usage of your program: moving your program
to other systems may involve changing the path to the executable,
which otherwise would work auto-detect and unmodified.
=item hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
The host on which the server runs. Some protocols accept an array
of alternatives for this option.
=item interval => SECONDS
The time between tries to contact the remote server for sending or
receiving a message in SECONDS. This number must be larger than 0.
=item log => LEVEL
=item password => STRING
Some protocols require a password to be given, usually in combination
with a password.
=item port => INTEGER
The port number behind which the service is hiding on the remote server.
=item proxy => PATH
The name of the proxy software (the protocol handler). This must be
the name (preferable the absolute path) of your mail delivery
software.
=item retry => NUMBER|undef
The number of retries before the sending will fail. If C, the
number of retries is unlimited.
=item timeout => SECONDS
SECONDS till time-out while establishing the connection to a remote server.
=item trace => LEVEL
=item username => STRING
Some protocols require a user to login.
=item via => CLASS|NAME
Which CLASS (extending C) will transport the data.
Some predefined NAMEs avoid long class names: C and C
are handled by the L module, C
and C belong to L, and C
is implemented in L. The C or C
protocol implementation can be found in L.
=back
=back
=head2 Server connection
=over 4
=item $obj-EB(NAME [, DIRECTORIES])
Look for a binary with the specified NAME in the directories which
are defined to be safe. The list of standard directories is followed
by the optional DIRECTORIES. The full pathname is returned.
You may specify L, which specifies the absolute name
of the binary to be used.
=item $obj-EB()
Returns the hostname, port number, username and password to be used to
establish the connection to the server for sending or receiving mail.
=item $obj-EB()
Returns the retry interval, retry count, and timeout for the connection.
=back
=head2 Error handling
See L.
=over 4
=item $obj-EB()
See L
=item $obj-EB(OBJECT)
See L
=item $obj-EB([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=item Mail::Transport-EB([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See L
=item $obj-EB()
See L
=item $obj-EB([LEVEL [,STRINGS]])
=item Mail::Transport-EB([LEVEL [,STRINGS]])
See L
=item $obj-EB(LEVEL)
=item Mail::Transport-EB(LEVEL)
See L
=item $obj-EB()
See L
=item $obj-EB()
See L
=item $obj-EB([LEVEL])
See L
=item $obj-EB([LEVEL])
See L
=item $obj-EB([LEVEL])
See L
=item $obj-EB()
See L
=back
=head2 Cleanup
See L.
=over 4
=item $obj-EB()
See L
=back
=head1 DIAGNOSTICS
=over 4
=item Warning: Avoid program abuse: specify an absolute path for $exec.
Specifying explicit locations for executables of email transfer agents
should only be done with absolute file names, to avoid various pontential
security problems.
=item Warning: Executable $exec does not exist.
The explicitly indicated mail transfer agent does not exists. The normal
settings are used to find the correct location.
=item 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.
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.108,
built on June 25, 2013. Website: F
=head1 LICENSE
Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F