package Email::Sender;
# ABSTRACT: a library for sending email
$Email::Sender::VERSION = '1.300011';
use Moo::Role;
requires 'send';

# =head1 SYNOPSIS
#
#   my $message = Email::MIME->create( ... );
#   # produce an Email::Abstract compatible message object,
#   # e.g. produced by Email::Simple, Email::MIME, Email::Stuff
#
#   use Email::Sender::Simple qw(sendmail);
#   use Email::Sender::Transport::SMTP qw();
#   use Try::Tiny;
#
#   try {
#     sendmail(
#       $message,
#       {
#         from => $SMTP_ENVELOPE_FROM_ADDRESS,
#         transport => Email::Sender::Transport::SMTP->new({
#             host => $SMTP_HOSTNAME,
#             port => $SMTP_PORT,
#         })
#       }
#     );
#   } catch {
#       warn "sending failed: $_";
#   };
#
# =head1 OVERVIEW
#
# Email::Sender replaces the old and sometimes problematic Email::Send library,
# which did a decent job at handling very simple email sending tasks, but was not
# suitable for serious use, for a variety of reasons.
#
# Most users will be able to use L<Email::Sender::Simple> to send mail.  Users
# with more specific needs should look at the available Email::Sender::Transport
# classes.
#
# Documentation may be found in L<Email::Sender::Manual>, and new users should
# start with L<Email::Sender::Manual::QuickStart>.
#
# =head1 IMPLEMENTING
#
# Email::Sender itself is a Moo role.  Any class that implements Email::Sender
# is required to provide a method called C<send>.  This method should accept any
# input that can be understood by L<Email::Abstract>, followed by a hashref
# containing C<to> and C<from> arguments to be used as the envelope.  The method
# should return an L<Email::Sender::Success> object on success or throw an
# L<Email::Sender::Failure> on failure.
#
# =cut

no Moo::Role;
1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Email::Sender - a library for sending email

=head1 VERSION

version 1.300011

=head1 SYNOPSIS

  my $message = Email::MIME->create( ... );
  # produce an Email::Abstract compatible message object,
  # e.g. produced by Email::Simple, Email::MIME, Email::Stuff

  use Email::Sender::Simple qw(sendmail);
  use Email::Sender::Transport::SMTP qw();
  use Try::Tiny;

  try {
    sendmail(
      $message,
      {
        from => $SMTP_ENVELOPE_FROM_ADDRESS,
        transport => Email::Sender::Transport::SMTP->new({
            host => $SMTP_HOSTNAME,
            port => $SMTP_PORT,
        })
      }
    );
  } catch {
      warn "sending failed: $_";
  };

=head1 OVERVIEW

Email::Sender replaces the old and sometimes problematic Email::Send library,
which did a decent job at handling very simple email sending tasks, but was not
suitable for serious use, for a variety of reasons.

Most users will be able to use L<Email::Sender::Simple> to send mail.  Users
with more specific needs should look at the available Email::Sender::Transport
classes.

Documentation may be found in L<Email::Sender::Manual>, and new users should
start with L<Email::Sender::Manual::QuickStart>.

=head1 IMPLEMENTING

Email::Sender itself is a Moo role.  Any class that implements Email::Sender
is required to provide a method called C<send>.  This method should accept any
input that can be understood by L<Email::Abstract>, followed by a hashref
containing C<to> and C<from> arguments to be used as the envelope.  The method
should return an L<Email::Sender::Success> object on success or throw an
L<Email::Sender::Failure> on failure.

=head1 AUTHOR

Ricardo Signes <rjbs@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Ricardo Signes.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut