1Email::Sender::Role::CoUmsmeornSCeonndtirnigb(u3t)ed PerElmaDiolc:u:mSeenntdaetri:o:nRole::CommonSending(3)
2
3
4

NAME

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

VERSION

10       version 0.101760
11

DESCRIPTION

13       Email::Sender::Role::CommonSending provides a number of features that
14       should ease writing new classes that perform the Email::Sender role.
15       Instead of writing a "send" method, implementors will need to write a
16       smaller "send_email" method, which will be passed an Email::Abstract
17       object and envelope containing "from" and "to" entries.  The "to" entry
18       will be guaranteed to be an array reference.
19
20       A "success" method will also be provided as a shortcut for calling:
21
22         Email::Sender::Success->new(...);
23
24       A few other minor details are handled by CommonSending; for more
25       information, consult the source.
26
27       The methods documented here may be overridden to alter the behavior of
28       the CommonSending role.
29

METHODS

31   prepare_email
32       This method is passed a scalar and is expected to return an
33       Email::Abstract object.  You probably shouldn't override it in most
34       cases.
35
36   prepare_envelope
37       This method is passed a hashref and returns a new hashref that should
38       be used as the envelope passed to the "send_email" method.  This method
39       is responsible for ensuring that the to entry is an array.
40
41   success
42         ...
43         return $self->success;
44
45       This method returns a new Email::Sender::Success object.  Arguments
46       passed to this method are passed along to the Success's constructor.
47       This is provided as a convenience for returning success from
48       subclasses' "send_email" methods.
49

AUTHOR

51       Ricardo Signes <rjbs@cpan.org>
52

54       This software is copyright (c) 2010 by Ricardo Signes.
55
56       This is free software; you can redistribute it and/or modify it under
57       the same terms as the Perl 5 programming language system itself.
58
59
60
61perl v5.12.1                      2010-06-E2m5ail::Sender::Role::CommonSending(3)
Impressum