File Coverage

blib/lib/Test/Reporter/Transport/Outlook.pm

Criterion	Covered	Total	%
statement	10	12	83.3
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	14	16	87.5

package Test::Reporter::Transport::Outlook;

=head1 NAME

Test::Reporter::Transport::Outlook - MS Outlook as transport for Test::Reporter

=cut

use strict;
use warnings;

require 5.008_008;

use base 'Test::Reporter::Transport';
use Mail::Outlook;
use Params::Validate qw(:types validate_pos);
use Devel::AssertOS qw(MSWin32);

=head1 SYNOPSIS

	use warnings;
	use strict;
	use Test::Reporter;
	use Test::Reporter::Transport::Outlook;

	my $reporter = Test::Reporter->new(
		grade        => 'fail',
		distribution => 'Mail-Freshmeat-1.20',
		from         => '[e-mail] (Whoever Wherever)',
		comments     => 'output of a failed make test goes here...',
		via          => 'CPANPLUS X.Y.Z',
	);

	my $sender = Test::Reporter::Transport::Outlook->new(0);

	$sender->send($reporter);

=head1 DESCRIPTION

If you want to test Perl modules for CPAN but is located in a very restricted environment, without HTTP or SMTP access
outside the network and can count only with an Outlook and Exchange server to send emails, this module is for you.

This module will use C module with MS Outlook to create a new email message. This message will contain
all information regarding the test report and I be ready to be sent I new security patches of Outlook
didn't forbid that.

As an alternative, the message can be saved on the "Drafts" (or whatever is called in your computer) or can be displayed
so you will only need to click (or review before clicking) the report. Default behavior is to save the email so you can
avoid having lot's of new email messages being opened if you're testing real hard new distributions.

Of course, this module expects that you're in a MS Windows machine with MS Outlook installed. This module will not work
in other operational systems.

=head1 USAGE

See L and L for general usage information.

=cut

our $VERSION = '0.01';

=head2 Transport Arguments

    $report->transport_args( 1 );

See C method to understand this parameter.

=head1 METHODS

These methods are only for internal use by Test::Reporter.

=head2 new

    my $sender = Test::Reporter::Transport::Outlook->new( 0 );

The C method is the object constructor.

There is an optional parameter that is related if the email will be saved in the Drafts folder (the default behavior)
or displayed to the user executing this module. The valid values are true (1) or false (0) respectivally. Anything
else will generate an exception.

To save the message, nothing needs to be passed. To display the message, pass 0 as an argument.

The message will be saved or displayed upon invocation of the method C.

=cut

sub new {

    my $class = shift;

    my @params =
      validate_pos( @_, { type => SCALAR, regex => qr/^1|0$/, default => 1 } );

    my $self =
      { _outlook => Mail::Outlook->new(), _is_draft => shift(@params) };

    return bless $self, $class;
}

=head2 get_outlook

Returns the C object that represents the MS Outlook application.

=cut

sub get_outlook {

    my $self = shift;

    return $self->{_outlook};

}

=head2 send

Display or save the message in the Outlook, depends on the values defined during object creation. See the method
C for more details.

Expects as a parameter a C object. Returns true in case of success or false in failure (1 or 0);

=cut

sub send {

    validate_pos(
        @_,
        { type => OBJECT, isa => 'Test::Reporter::Transport::Outlook' },
        { type => OBJECT, isa => 'Test::Reporter' }
    );

    my ( $self, $report ) = @_;

    my $message = $self->get_outlook()->create();

    $message->To( $report->address() );
    $message->Subject( $report->subject() );
    $message->Body( $report->report() );

    if ( $self->{_is_draft} ) {

        return $message->save();

    }
    else {

        return $message->display();

    }

}

1;

__END__