X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FView%2FEmail%2FTemplate.pm;h=66d54e0a07bf0d1800c3f509698c1fb939ce2600;hb=b7b30250454cdf1834f4dc8107d61bcb12712f46;hp=2ee30802f8224768d81d6c94407efaa103468baa;hpb=81e9d47036f52db0c47c1ecdba661e49f4e426c4;p=catagits%2FCatalyst-View-Email.git diff --git a/lib/Catalyst/View/Email/Template.pm b/lib/Catalyst/View/Email/Template.pm index 2ee3080..66d54e0 100644 --- a/lib/Catalyst/View/Email/Template.pm +++ b/lib/Catalyst/View/Email/Template.pm @@ -5,12 +5,13 @@ use strict; use Class::C3; use Carp; +use Scalar::Util qw/ blessed /; use Email::MIME::Creator; -use base qw|Catalyst::View::Email|; +use base qw/ Catalyst::View::Email /; -our $VERSION = '0.01'; +our $VERSION = '0.11'; =head1 NAME @@ -18,48 +19,85 @@ Catalyst::View::Email::Template - Send Templated Email from Catalyst =head1 SYNOPSIS -Sends Templated mail, based upon your Default View. Will capture the output +Sends templated mail, based upon your default view. It captures the output of the rendering path, slurps in based on mime-types and assembles a multi-part -email and sends it out. +email using L and sends it out. -=head2 CONFIGURATION +=head1 CONFIGURATION + +WARNING: since version 0.10 the configuration options slightly changed! + +Use the helper to create your view: + + $ script/myapp_create.pl view Email::Template Email::Template + +For basic configuration look at L. + +In your app configuration (example in L): View::Email::Template: - # Set it up so if you have multiple parts, they're alternatives. - # This is on the top-level message, not the individual parts. - content_type: multipart/alternative # Optional prefix to look somewhere under the existing configured # template paths. + # Default: none template_prefix: email - # Where to look in the stash for the email information - stash_key: email - # Setup how to send the email - sender: - method: SMTP - host: smtp.myhost.com - username: username - password: password + # Define the defaults for the mail + default: + # Defines the default view used to render the templates. + # If none is specified neither here nor in the stash + # Catalysts default view is used. + # Warning: if you don't tell Catalyst explicit which of your views should + # be its default one, C::V::Email::Template may choose the wrong one! + view: TT =head1 SENDING EMAIL -Sending email is just setting up your stash key, and forwarding to the view. +Sending email works just like for L but by specifying +the template instead of the body and forwarding to your Email::Template view: + + sub controller : Private { + my ( $self, $c ) = @_; + + $c->stash->{email} = { + to => 'jshirley@gmail.com', + cc => 'abraxxa@cpan.org', + bcc => [ qw/hidden@secret.com hidden2@foobar.com/ ], + from => 'no-reply@foobar.com', + subject => 'I am a Catalyst generated email', + template => 'test.tt', + content_type => 'multipart/alternative' + }; + + $c->forward( $c->view('Email::Template') ); + } - $c->stash->{email} = { - to => 'jshirley@gmail.com', - from => 'no-reply@foobar.com', - subject => 'I am a Catalyst generated email', - # Specify which templates to include - templates => [ - qw{text_plain/test.tt}, - qw{text_html/test.tt} - ] - }; - $c->forward('View::Email::Template'); +Alternatively if you want more control over your templates you can use the following idiom +to override the defaults: + + templates => [ + { + template => 'email/test.html.tt', + content_type => 'text/html', + charset => 'utf-8', + view => 'TT', + }, + { + template => 'email/test.plain.mason', + content_type => 'text/plain', + charset => 'utf-8', + view => 'Mason', + } + ] + + +=head1 HANDLING ERRORS -If it fails $c->error will have the error message. +See L. =cut +# here the defaults of Catalyst::View::Email are extended by the additional +# ones Template.pm needs. + __PACKAGE__->config( template_prefix => '', ); @@ -77,78 +115,156 @@ __PACKAGE__->config( # into an Email::MIME container. The mime-type will be stupidly guessed with # the subdir on the template. # -# TODO: Make this unretarded. -# -sub process { - my ( $self, $c ) = @_; - my $stash_key = $self->config->{stash_key} || 'email'; +# Set it up so if you have multiple parts, they're alternatives. +# This is on the top-level message, not the individual parts. +#multipart/alternative + +sub _validate_view { + my ($self, $view) = @_; + + croak "C::V::Email::Template's configured view '$view' isn't an object!" + unless (blessed($view)); + + croak "C::V::Email::Template's configured view '$view' isn't an Catalyst::View!" + unless ($view->isa('Catalyst::View')); + + croak "C::V::Email::Template's configured view '$view' doesn't have a render method!" + unless ($view->can('render')); +} + +=head1 METHODS + +=over 4 + +=item generate_part + +Generates a MIME part to include in the email. Since the email is template based +every template piece is a separate part that is included in the email. + +=cut - croak "No template specified for rendering" - unless $c->stash->{$stash_key}->{template} or - $c->stash->{$stash_key}->{templates}; +sub generate_part { + my ($self, $c, $attrs) = @_; - # Where to look - my $template_prefix = $self->config->{template_prefix}; - my @templates = (); - if ( $c->stash->{$stash_key}->{templates} ) { - push @templates, map { - join('/', $template_prefix, $_); - } @{$c->stash->{$stash_key}->{templates}}; + my $template_prefix = $self->{template_prefix}; + my $default_view = $self->{default}->{view}; + my $default_content_type = $self->{default}->{content_type}; + my $default_charset = $self->{default}->{charset}; - } else { - push @templates, join('/', $template_prefix, - $c->stash->{$stash_key}->{template}); + my $view; + # use the view specified for the email part + if (exists $attrs->{view} && defined $attrs->{view} && $attrs->{view} ne '') { + $view = $c->view($attrs->{view}); + $c->log->debug("C::V::Email::Template uses specified view $view for rendering.") if $c->debug; + } + # if none specified use the configured default view + elsif ($default_view) { + $view = $c->view($default_view); + $c->log->debug("C::V::Email::Template uses default view $view for rendering.") if $c->debug;; + } + # else fallback to Catalysts default view + else { + $view = $c->view; + $c->log->debug("C::V::Email::Template uses Catalysts default view $view for rendering.") if $c->debug;; } - - my $default_view = $c->view( $self->config->{default_view} ); - unless ( $default_view->can('render') ) { - croak "Email::Template's configured view does not have a render method!"; + # validate the per template view + $self->_validate_view($view); + + # prefix with template_prefix if configured + my $template = $template_prefix ne '' ? join('/', $template_prefix, $attrs->{template}) : $attrs->{template}; + + # setup the attributes (merge with defaults) + my $e_m_attrs = $self->setup_attributes($c, $attrs); + + # render the email part + my $output = $view->render( $c, $template, { + content_type => $e_m_attrs->{content_type}, + stash_key => $self->{stash_key}, + %{$c->stash}, + }); + + if ( ref $output ) { + croak $output->can('as_string') ? $output->as_string : $output; } - #$c->log->_dump($default_view->config); + return Email::MIME->create( + attributes => $e_m_attrs, + body => $output, + ); +} + +=item process + +The process method is called when the view is dispatched to. This creates the +multipart message and then sends the message contents off to +L for processing, which in turn hands off to +L. + +=cut + +sub process { + my ( $self, $c, @args ) = @_; + + # don't validate template_prefix + + # the default view is validated if used + + # the content type should be validated by Email::MIME::Creator + + my $stash_key = $self->{stash_key}; + # Go upstream if we don't have a template + $self->next::method($c, @args) + unless $c->stash->{$stash_key}->{template} + or $c->stash->{$stash_key}->{templates}; + + # this array holds the Email::MIME objects + # in case of the simple api only one my @parts = (); - foreach my $template ( @templates ) { - $template =~ s#^/+##; # Make sure that we don't have an absolute path. - # This seems really stupid to me... argh. will give me nightmares! - my $template_path = $template; - $template_path =~ s#^$template_prefix/##; - my ( $content_type, $extra ) = split('/', $template_path); - if ( $extra ) { - $content_type ||= 'text/plain'; - $content_type =~ s#_#/#; - } else { - $content_type = 'text/plain'; - } - my $output = $default_view->render( $c, $template, - { content_type => $content_type, %{$c->stash} }); - # Got a ref, not a scalar. An error! - if ( ref $output ) { - croak $output->can("as_string") ? $output->as_string : $output; + + # now find out if the single or multipart api was used + # prefer the multipart one + + # multipart api + if ($c->stash->{$stash_key}->{templates} + && ref $c->stash->{$stash_key}->{templates} eq 'ARRAY' + && ref $c->stash->{$stash_key}->{templates}[0] eq 'HASH') { + # loop through all parts of the mail + foreach my $part (@{$c->stash->{$stash_key}->{templates}}) { + push @parts, $self->generate_part($c, { + view => $part->{view}, + template => $part->{template}, + content_type => $part->{content_type}, + charset => $part->{charset}, + }); } - push @parts, Email::MIME->create( - attributes => { - content_type => $content_type - }, - body => $output - ); } - delete $c->stash->{email}->{body}; - $c->stash->{email}->{parts} ||= []; - push @{$c->stash->{email}->{parts}}, @parts; + # single part api + elsif($c->stash->{$stash_key}->{template}) { + push @parts, $self->generate_part($c, { + template => $c->stash->{$stash_key}->{template}, + }); + } + + delete $c->stash->{$stash_key}->{body}; + $c->stash->{$stash_key}->{parts} ||= []; + push @{$c->stash->{$stash_key}->{parts}}, @parts; # Let C::V::Email do the actual sending. We just assemble the tasty bits. return $self->next::method($c); } +=back + =head1 TODO =head2 ATTACHMENTS There needs to be a method to support attachments. What I am thinking is something along these lines: + attachments => [ # Set the body to a file handle object, specify content_type and # the file name. (name is what it is sent at, not the file) @@ -171,6 +287,10 @@ something along these lines: J. Shirley +Simon Elliott + +Alexander Hartmaier + =head1 LICENSE This library is free software, you can redistribute it and/or modify it under @@ -179,4 +299,3 @@ the same terms as Perl itself. =cut 1; -