| Email-MIME-Kit documentation | Contained in the Email-MIME-Kit distribution. |
Email::MIME::Kit - build messages from templates
version 2.102010
use Email::MIME::Kit;
my $kit = Email::MIME::Kit->new({ source => 'mkits/sample.mkit' });
my $email = $kit->assemble({
account => $new_signup,
verification_code => $token,
... and any other template vars ...
});
$transport->send($email, { ... });
Email::MIME::Kit is a templating system for email messages. Instead of trying to be yet another templating system for chunks of text, it makes it easy to build complete email messages.
It handles the construction of multipart messages, text and HTML alternatives, attachments, interpart linking, string encoding, and parameter validation.
Although nearly every part of Email::MIME::Kit is a replaceable component, the stock configuration is probably enough for most use. A message kit will be stored as a directory that might look like this:
sample.mkit/
manifest.json
body.txt
body.html
logo.jpg
The manifest file tells Email::MIME::Kit how to put it all together, and might look something like this:
{
"renderer": "TT",
"header": [
{ "From": "WY Corp <noreplies@wy.example.com>" },
{ "Subject": "Welcome aboard, [% recruit.name %]!" }
],
"alternatives": [
{ "type": "text/plain", "path": "body.txt" },
{
"type": "text/html",
"path": "body.html",
"container_type": "multipart/related",
"attachments": [ { "type": "image/jpeg", "path": "logo.jpg" } ]
}
]
}
Please note: the assembly of HTML documents as multipart/related bodies will probably be simplified with an alternate assembler in the near future.
The above manifest would build a multipart alternative message. GUI mail clients would see a rendered HTML document with the logo graphic visible from the attachment. Text mail clients would see the plaintext.
Both the HTML and text parts would be rendered using the named renderer, which here is Template-Toolkit.
The message would be assembled and returned as an Email::MIME object, just as easily as suggested in the SYNOPSIS above.
This module is maintained by the Perl Email Project
This code was written in 2009 by Ricardo SIGNES. It was based on a previous implementation by Hans Dieter Pearcey written in 2006.
The development of this code was sponsored by Pobox.com. Thanks, Pobox!
Ricardo Signes <rjbs@cpan.org>
This software is copyright (c) 2010 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.
| Email-MIME-Kit documentation | Contained in the Email-MIME-Kit distribution. |
package Email::MIME::Kit; BEGIN { $Email::MIME::Kit::VERSION = '2.102010'; } require 5.008; use Moose; use Moose::Util::TypeConstraints; # ABSTRACT: build messages from templates use Email::MIME; use Email::MessageID; use String::RewritePrefix; has source => (is => 'ro', required => 1); has manifest => (reader => 'manifest', writer => '_set_manifest'); my @auto_attrs = ( [ manifest_reader => ManifestReader => JSON => 'read_manifest' ], [ kit_reader => KitReader => Dir => 'get_kit_entry' ], ); for my $attr (@auto_attrs) { has $attr->[0] => ( reader => $attr->[0], writer => "_set_$attr->[0]", default => sub { undef }, required => 1, initializer => sub { my ($self, $value, $set) = @_; $value ||= "=Email::MIME::Kit::$attr->[1]::$attr->[2]"; my $comp = $self->_build_component( "Email::MIME::Kit::$attr->[1]", $value, ); confess "$value is not a valid $attr->[0] value" unless role_type("Email::MIME::Kit::Role::$attr->[1]")->check($comp); $set->($comp); }, handles => [ $attr->[3] ], ); } has validator => ( is => 'ro', isa => maybe_type(role_type('Email::MIME::Kit::Role::Validator')), lazy => 1, # is this really needed? -- rjbs, 2009-01-20 default => sub { my ($self) = @_; return $self->_build_component( 'Email::MIME::Kit::Validator', $self->manifest->{validator}, ); }, ); sub _build_component { my ($self, $base_namespace, $entry, $extra) = @_; return unless $entry; my ($class, $arg); if (ref $entry) { ($class, $arg) = @$entry; } else { ($class, $arg) = ($entry, {}); } $class = String::RewritePrefix->rewrite( { '=' => '', '' => ($base_namespace . q{::}) }, $class, ); eval "require $class; 1" or die $@; $class->new({ %$arg, %{ $extra || {} }, kit => $self }); } sub BUILD { my ($self) = @_; my $manifest = $self->read_manifest; $self->_set_manifest($manifest); if ($manifest->{kit_reader}) { my $kit_reader = $self->_build_component( 'Email::MIME::Kit::KitReader', $manifest->{kit_reader}, ); $self->_set_kit_reader($kit_reader); } $self->_setup_default_renderer; } sub _setup_default_renderer { my ($self) = @_; return unless my $renderer = $self->_build_component( 'Email::MIME::Kit::Renderer', $self->manifest->{renderer}, ); $self->_set_default_renderer($renderer); } sub assemble { my ($self, $stash) = @_; $self->validator->validate($stash) if $self->validator; # Do I really need or want to do this? Anything that alters the stash should # do so via localization. -- rjbs, 2009-01-20 my $copied_stash = { %{ $stash || {} } }; my $email = $self->assembler->assemble($copied_stash); my $header = $email->header('Message-ID'); $email->header_set('Message-ID' => $self->_generate_content_id->in_brackets) unless defined $header; return $email; } sub kit { $_[0] } sub _assembler_from_manifest { my ($self, $manifest, $parent) = @_; $self->_build_component( 'Email::MIME::Kit::Assembler', $manifest->{assembler} || 'Standard', { manifest => $manifest, parent => $parent, }, ); } has default_renderer => ( reader => 'default_renderer', writer => '_set_default_renderer', isa => role_type('Email::MIME::Kit::Role::Renderer'), ); has assembler => ( reader => 'assembler', isa => role_type('Email::MIME::Kit::Role::Assembler'), required => 1, lazy => 1, default => sub { my ($self) = @_; return $self->_assembler_from_manifest($self->manifest); } ); sub _generate_content_id { Email::MessageID->new; } no Moose::Util::TypeConstraints; no Moose; 1; __END__