Test::Reporter::Transport(3pm) User Contributed Perl Documentation Test::Reporter::Transport(3pm)NAME
Test::Reporter::Transport - base class for Test::Reporter transports
VERSION
version 1.58
SYNOPSIS
# Defines API that must be implemented by subclasses
my $sender = Test::Reporter::Transport::Subclass->new( @args );
$sender->send( $report )
DESCRIPTION
Transport subclasses provide the means by which CPAN Testers reports are transmitted to the CPAN Testers mailing list.
This module is an abstract base class that define an API for Test::Reporter::Transport subclasses. Individual subclasses MUST implement
the methods described below.
USAGE
A transport method is specified to Test::Reporter using the "transport" option. The "transport" option expects just the module "suffix"
that follows "Test::Reporter::Transport". For example:
# use Test::Reporter::Transport::Null for transport
my $report = Test::Reporter->new(
transport => 'Null'
);
Configuration of the transport is specified with the "transport_args" option:
my $report = Test::Reporter->new(
transport => 'File',
transport_args => [ dir => '/tmp' ],
);
These may also be specified with the "transport" or "transport_args" methods:
$report->transport_args( dir => '/tmp' );
These may also be combined in the "transport" method itself:
$report->transport( 'File', dir => '/tmp' );
METHODS
The terms 'may', 'must', 'should', etc. used below have their usual RFC meanings.
new
my $sender = $subclass->new( @args );
The "new" method is the object constructor. It MAY take a list of any necessary configuration options. It MUST return a transport object
if one is successfully created or undef if the object can not be created.
send
$sender->send( $report );
The "send" method MUST take a Test::Reporter object as its only argument. It MUST return true if the report is successfully sent. It
SHOULD die with a message describing the failure if a report cannot be sent. It MUST NOT return a true value if the report cannot be sent.
AUTHORS
o Adam J. Foxson <afoxson@pobox.com>
o David Golden <dagolden@cpan.org>
o Kirrily "Skud" Robert <skud@cpan.org>
o Ricardo Signes <rjbs@cpan.org>
o Richard Soderberg <rsod@cpan.org>
o Kurt Starsinic <Kurt.Starsinic@isinet.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Authors and Contributors.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
perl v5.12.4 2011-07-19 Test::Reporter::Transport(3pm)
Check Out this Related Man Page
Mail::Transport::Mailx(3pm) User Contributed Perl Documentation Mail::Transport::Mailx(3pm)NAME
Mail::Transport::Mailx - transmit messages using external mailx program
INHERITANCE
Mail::Transport::Mailx
is a Mail::Transport::Send
is a Mail::Transport
is a Mail::Reporter
SYNOPSIS
my $sender = Mail::Transport::Mailx->new(...);
$sender->send($message);
DESCRIPTION
Implements mail transport using the external programs 'mailx', "Mail", or 'mail'. When instantiated, the mailer will look for any of these
binaries in specific system directories, and the first program found is taken.
WARNING: There are many security issues with mail and mailx. DO NOT USE these commands to send messages which contains data derived from
any external source!!!
Under Linux, freebsd, and bsdos the "mail", "Mail", and "mailx" names are just links to the same binary. The implementation is very
primitive, pre-MIME standard, what may cause many headers to be lost. For these platforms (and probably for other platforms as well), you
can better not use this transport mechanism.
METHODS
Constructors
Mail::Transport::Mailx->new(OPTIONS)
-Option--Defined in --Default
executable Mail::Transport undef
hostname Mail::Transport 'localhost'
interval Mail::Transport 30
log Mail::Reporter 'WARNINGS'
password Mail::Transport undef
port Mail::Transport undef
proxy Mail::Transport undef
retry Mail::Transport <false>
style <autodetect>
timeout Mail::Transport 120
trace Mail::Reporter 'WARNINGS'
username Mail::Transport undef
via Mail::Transport 'mailx'
executable => FILENAME
hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
interval => SECONDS
log => LEVEL
password => STRING
port => INTEGER
proxy => PATH
retry => NUMBER|undef
style => 'BSD'|'RFC822'
There are two version of the "mail" program. The newest accepts RFC822 messages, and automagically collect information about where
the message is to be send to. The BSD style mail command predates MIME, and expects lines which start with a '~' (tilde) to specify
destinations and such. This field is autodetect, however on some platforms both versions of "mail" can live (like various Linux
distributions).
timeout => SECONDS
trace => LEVEL
username => STRING
via => CLASS|NAME
Sending mail
$obj->destinations(MESSAGE, [ADDRESS|ARRAY-OF-ADDRESSES])
See "Sending mail" in Mail::Transport::Send
$obj->putContent(MESSAGE, FILEHANDLE, OPTIONS)
See "Sending mail" in Mail::Transport::Send
$obj->send(MESSAGE, OPTIONS)
See "Sending mail" in Mail::Transport::Send
$obj->trySend(MESSAGE, OPTIONS)
Server connection
$obj->findBinary(NAME [, DIRECTORIES])
See "Server connection" in Mail::Transport
$obj->remoteHost()
See "Server connection" in Mail::Transport
$obj->retry()
See "Server connection" in Mail::Transport
Error handling
$obj->AUTOLOAD()
See "Error handling" in Mail::Reporter
$obj->addReport(OBJECT)
See "Error handling" in Mail::Reporter
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Transport::Mailx->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See "Error handling" in Mail::Reporter
$obj->errors()
See "Error handling" in Mail::Reporter
$obj->log([LEVEL [,STRINGS]])
Mail::Transport::Mailx->log([LEVEL [,STRINGS]])
See "Error handling" in Mail::Reporter
$obj->logPriority(LEVEL)
Mail::Transport::Mailx->logPriority(LEVEL)
See "Error handling" in Mail::Reporter
$obj->logSettings()
See "Error handling" in Mail::Reporter
$obj->notImplemented()
See "Error handling" in Mail::Reporter
$obj->report([LEVEL])
See "Error handling" in Mail::Reporter
$obj->reportAll([LEVEL])
See "Error handling" in Mail::Reporter
$obj->trace([LEVEL])
See "Error handling" in Mail::Reporter
$obj->warnings()
See "Error handling" in Mail::Reporter
Cleanup
$obj->DESTROY()
See "Cleanup" in Mail::Reporter
$obj->inGlobalDestruction()
See "Cleanup" in Mail::Reporter
DIAGNOSTICS
Warning: Message has no destination
It was not possible to figure-out where the message is intended to go to.
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.
Warning: Resent group does not specify a destination
The message which is sent is the result of a bounce (for instance created with Mail::Message::bounce()), and therefore starts with a
"Received" header field. With the "bounce", the new destination(s) of the message are given, which should be included as "Resent-To",
"Resent-Cc", and "Resent-Bcc".
The "To", "Cc", and "Bcc" header information is only used if no "Received" was found. That seems to be the best explanation of the
RFC.
As alternative, you may also specify the "to" option to some of the senders (for instance Mail::Transport::SMTP::send(to) to overrule
any information found in the message itself about the destination.
Error: Sending via mailx mailer $program failed: $! ($?)
Mailx (in some shape: there are many different implementations) did start accepting messages, but did not succeed sending it.
SEE ALSO
This module is part of Mail-Box distribution version 2.105, built on May 07, 2012. Website: http://perl.overmeer.net/mailbox/
LICENSE
Copyrights 2001-2012 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
http://www.perl.com/perl/misc/Artistic.html
perl v5.14.2 2012-05-07 Mail::Transport::Mailx(3pm)