1 package Catalyst::View::Email::Template;
8 use Scalar::Util qw/ blessed /;
10 use Email::MIME::Creator;
12 use base qw/ Catalyst::View::Email /;
14 our $VERSION = '0.09999_02';
18 Catalyst::View::Email::Template - Send Templated Email from Catalyst
22 Sends Templated mail, based upon your default view. It captures the output
23 of the rendering path, slurps in based on mime-types and assembles a multi-part
24 email using Email::MIME::Creator and sends it out.
28 Use the helper to create your View:
30 $ script/myapp_create.pl view Email::Template Email::Template
32 In your app configuration (example in L<YAML>):
34 View::Email::Template:
35 # Optional prefix to look somewhere under the existing configured
38 template_prefix: email
39 # Where to look in the stash for the email information.
42 # Define the defaults for the mail
44 # Defines the default content type (mime type).
46 content_type: text/html
47 # Defines the default charset for every MIME part with the content
49 # According to RFC2049 a MIME part without a charset should
50 # be treated as US-ASCII by the mail client.
51 # If the charset is not set it won't be set for all MIME parts
52 # without an overridden one.
55 # Defines the default view used to render the templates.
56 # If none is specified neither here nor in the stash
57 # Catalysts default view is used.
58 # Warning: if you don't tell Catalyst explicit which of your views should
59 # be its default one, C::V::Email::Template may choose the wrong one!
61 # Setup how to send the email
62 # All those options are passed directly to Email::Send,
63 # for all available options look at its docs.
67 Host: smtp.example.com # defaults to localhost
73 Sending email is just setting up your defaults, the stash key and forwarding to the view.
75 $c->stash->{email} = {
76 to => 'jshirley@gmail.com',
77 from => 'no-reply@foobar.com',
78 subject => 'I am a Catalyst generated email',
79 template => 'test.tt',
81 $c->forward( $c->view('Email::Template' ) );
83 Alternatively if you want more control over your templates you can use the following idiom
84 to override the defaults:
88 template => 'email/test.html.tt',
89 content_type => 'text/html',
94 template => 'email/test.plain.mason',
95 content_type => 'text/plain',
102 If it fails $c->error will have the error message.
106 # here the defaults of Catalyst::View::Email are extended by the additional
107 # ones Template.pm needs.
110 template_prefix => '',
114 # This view hitches into your default view and will call the render function
115 # on the templates provided. This means that you have a layer of abstraction
116 # and you aren't required to modify your templates based on your desired engine
117 # (Template Toolkit or Mason, for example). As long as the view adequately
118 # supports ->render, all things are good. Mason, and others, are not good.
121 # The path here is to check configuration for the template root, and then
122 # proceed to call render on the subsequent templates and stuff each one
123 # into an Email::MIME container. The mime-type will be stupidly guessed with
124 # the subdir on the template.
127 # Set it up so if you have multiple parts, they're alternatives.
128 # This is on the top-level message, not the individual parts.
129 #multipart/alternative
132 my ($self, $view) = @_;
134 croak "Email::Template's configured view '$view' isn't an object!"
135 unless (blessed($view));
137 croak "Email::Template's configured view '$view' isn't an Catalyst::View!"
138 unless ($view->isa('Catalyst::View'));
140 croak "Email::Template's configured view '$view' doesn't have a render method!"
141 unless ($view->can('render'));
146 Generate a MIME part to include in the email. Since the email is template based
147 every template piece is a separate part that is included in the email.
152 my ($self, $c, $attrs) = @_;
154 my $template_prefix = $self->{template_prefix};
155 my $default_view = $self->{default}->{view};
156 my $default_content_type = $self->{default}->{content_type};
157 my $default_charset = $self->{default}->{charset};
160 # use the view specified for the email part
161 if (exists $attrs->{view} && defined $attrs->{view} && $attrs->{view} ne '') {
162 $view = $c->view($attrs->{view});
163 $c->log->debug("C::V::Email::Template uses specified view $view for rendering.") if $c->debug;
165 # if none specified use the configured default view
166 elsif ($default_view) {
167 $view = $c->view($default_view);
168 $c->log->debug("C::V::Email::Template uses default view $view for rendering.") if $c->debug;;
170 # else fallback to Catalysts default view
173 $c->log->debug("C::V::Email::Template uses Catalysts default view $view for rendering.") if $c->debug;;
176 # validate the per template view
177 $self->_validate_view($view);
179 # prefix with template_prefix if configured
180 my $template = $template_prefix ne '' ? join('/', $template_prefix, $attrs->{template}) : $attrs->{template};
182 # setup the attributes (merge with defaults)
183 my $e_m_attrs = $self->setup_attributes($c, $attrs);
185 # render the email part
186 my $output = $view->render( $c, $template, {
187 content_type => $e_m_attrs->{content_type},
188 stash_key => $self->{stash_key},
193 croak $output->can('as_string') ? $output->as_string : $output;
196 return Email::MIME->create(
197 attributes => $e_m_attrs,
204 The process method is called when the view is dispatched to. This creates the
205 multipart message and then sends the message contents off to
206 L<Catalyst::View::Email> for processing, which in turn hands off to
212 my ( $self, $c ) = @_;
214 # don't validate template_prefix
216 # the default view is validated if used
218 # the content type should be validated by Email::MIME::Creator
220 my $stash_key = $self->{stash_key};
222 croak "No template specified for rendering"
223 unless $c->stash->{$stash_key}->{template}
224 or $c->stash->{$stash_key}->{templates};
226 # this array holds the Email::MIME objects
227 # in case of the simple api only one
230 # now find out if the single or multipart api was used
231 # prefer the multipart one
234 if ($c->stash->{$stash_key}->{templates}
235 && ref $c->stash->{$stash_key}->{templates} eq 'ARRAY'
236 && ref $c->stash->{$stash_key}->{templates}[0] eq 'HASH') {
237 # loop through all parts of the mail
238 foreach my $part (@{$c->stash->{$stash_key}->{templates}}) {
239 push @parts, $self->generate_part($c, {
240 view => $part->{view},
241 template => $part->{template},
242 content_type => $part->{content_type},
243 charset => $part->{charset},
248 elsif($c->stash->{$stash_key}->{template}) {
249 push @parts, $self->generate_part($c, {
250 template => $c->stash->{$stash_key}->{template},
254 delete $c->stash->{$stash_key}->{body};
255 $c->stash->{$stash_key}->{parts} ||= [];
256 push @{$c->stash->{$stash_key}->{parts}}, @parts;
258 # Let C::V::Email do the actual sending. We just assemble the tasty bits.
259 return $self->next::method($c);
266 There needs to be a method to support attachments. What I am thinking is
267 something along these lines:
270 # Set the body to a file handle object, specify content_type and
271 # the file name. (name is what it is sent at, not the file)
272 { body => $fh, name => "foo.pdf", content_type => "application/pdf" },
273 # Or, specify a filename that is added, and hey, encoding!
274 { filename => "foo.gif", name => "foo.gif", content_type => "application/pdf", encoding => "quoted-printable" },
275 # Or, just a path to a file, and do some guesswork for the content type
276 "/path/to/somefile.pdf",
281 =head2 L<Catalyst::View::Email> - Send plain boring emails with Catalyst
283 =head2 L<Catalyst::Manual> - The Catalyst Manual
285 =head2 L<Catalyst::Manual::Cookbook> - The Catalyst Cookbook
289 J. Shirley <jshirley@gmail.com>
291 Simon Elliott <cpan@browsing.co.uk>
293 Alexander Hartmaier <alex_hartmaier@hotmail.com>
297 This library is free software, you can redistribute it and/or modify it under
298 the same terms as Perl itself.