email::sender::role::commonsending(3pm) [debian man page]

Email::Sender::Role::CommonSending(3pm) 		User Contributed Perl Documentation		   Email::Sender::Role::CommonSending(3pm)

NAME

       Email::Sender::Role::CommonSending - the common sending tasks most Email::Sender classes will need

VERSION

       version 0.110005

DESCRIPTION

       Email::Sender::Role::CommonSending provides a number of features that should ease writing new classes that perform the Email::Sender role.
       Instead of writing a "send" method, implementors will need to write a smaller "send_email" method, which will be passed an Email::Abstract
       object and envelope containing "from" and "to" entries.	The "to" entry will be guaranteed to be an array reference.

       A "success" method will also be provided as a shortcut for calling:

	 Email::Sender::Success->new(...);

       A few other minor details are handled by CommonSending; for more information, consult the source.

       The methods documented here may be overridden to alter the behavior of the CommonSending role.

METHODS

   prepare_email
       This method is passed a scalar and is expected to return an Email::Abstract object.  You probably shouldn't override it in most cases.

   prepare_envelope
       This method is passed a hashref and returns a new hashref that should be used as the envelope passed to the "send_email" method.  This
       method is responsible for ensuring that the to entry is an array.

   success
	 ...
	 return $self->success;

       This method returns a new Email::Sender::Success object.  Arguments passed to this method are passed along to the Success's constructor.
       This is provided as a convenience for returning success from subclasses' "send_email" methods.

AUTHOR

       Ricardo Signes <rjbs@cpan.org>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 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.

perl v5.14.2							    2012-03-06				   Email::Sender::Role::CommonSending(3pm)

Email::Sender(3pm)					User Contributed Perl Documentation					Email::Sender(3pm)

NAME

       Email::Sender - a library for sending email

VERSION

       version 0.110005

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: $_";
	 };

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 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 Email::Sender::Manual, and new users should start with Email::Sender::Manual::QuickStart.

IMPLEMENTING

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

AUTHOR

       Ricardo Signes <rjbs@cpan.org>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 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.

perl v5.14.2							    2012-03-06							Email::Sender(3pm)