File Coverage

blib/lib/Email/Sender/Transport.pm

Criterion	Covered	Total	%
statement	9	10	90.0
branch	2	2	100.0
condition			n/a
subroutine	3	4	75.0
pod	0	2	0.0
total	14	18	77.7

package Email::Sender::Transport 1.500;
# ABSTRACT: a role for email transports

use Moo::Role;

#pod =head1 DESCRIPTION
#pod
#pod Email::Sender::Transport is a Moo role to aid in writing classes used to send
#pod mail.  For the most part, its behavior comes entirely from the role
#pod L, which it includes. The important
#pod difference is that Transports are often intended to be used by
#pod L, and they provide two methods related to that purpose.
#pod
#pod =for Pod::Coverage is_simple allow_partial_success
#pod
#pod First, they provide an C method which returns true or
#pod false to indicate whether the transport will ever signal partial success.
#pod
#pod Second, they provide an C method, which returns true if the
#pod transport is suitable for use with Email::Sender::Simple.  By default, this
#pod method returns the inverse of C.
#pod
#pod It is B that these methods be accurate to prevent
#pod Email::Sender::Simple users from sending partially successful transmissions.
#pod Partial success is a complex case that almost all users will wish to avoid at
#pod all times.
#pod
#pod =cut

with 'Email::Sender::Role::CommonSending';

sub is_simple {
  my ($self) = @_;
  return if $self->allow_partial_success;
  return 1;
}

sub allow_partial_success { 0 }

no Moo::Role;
1;

__END__