File Coverage

blib/lib/Catalyst/Helper/Model/Email.pm

Criterion	Covered	Total	%
statement	9	14	64.2
branch			n/a
condition			n/a
subroutine	3	4	75.0
pod	1	1	100.0
total	13	19	68.4

package Catalyst::Helper::Model::Email;
use strict;
use warnings;

use 5.008_008;

our $VERSION = '0.04';

sub mk_compclass {
    my ( $class, $helper, @mailer_args ) = @_;
    my %args;
    @args{qw/mailer host username password/} = @mailer_args;
    $helper->render_file( 'compclass', $helper->{file}, \%args );
    return;
}

=head1 NAME

Catalyst::Helper::Model::Email - Helper for Mail::Builder::Simple

=head1 VERSION

Version 0.03

=head1 SYNOPSIS

 ./script/myapp_create.pl model Email1 Email SMTP smtp.host.com usr passwd

=head1 DESCRIPTION

Using the command line above, Catalyst::Helper::Model::Email will create C that looks like:

 package MyApp::Model::Email1;
 use strict;
 use warnings;
 use base 'Catalyst::Model::Factory';

 __PACKAGE__->config(
   class       => 'Mail::Builder::Simple',
   args => {
     mail_client => {
       mailer => 'SMTP',
       mailer_args => {
         host => 'smtp.host.com',
         username => 'usr',
         password => 'passwd',
       },
     },
   },
 );

 1;

And you will be able to send email with this model, using the following code in your controllers:

 $c->model("Email1"->send(
   from => '[e-mail]',
   to => '[e-mail]',
   subject => 'The subject with UTF-8 chars',
   plaintext => "Hello\n\nHow are you?\n\n",
 );

But you will be also able to send more complex email messages like:

 $c->model("Email1"->send(
   from => ['[e-mail]', 'My Name'],
   to => ['[e-mail]', 'Your Name'],
   subject => 'The subject with UTF-8 chars',
   plaintext => "Hello\n\nHow are you?\n\n",
   htmltext => "Hello How are you?",
   attachment => ['file', 'filename.pdf', 'application/pdf'],
   image => ['logo.png', 'image_id_here'],
   priority => 1,
   mailer => 'My Emailer 0.01',
   'X-Special-Header' => 'My special header',
 );

...or even more complex messages, using templates.

=head1 SUBROUTINES/METHODS

=head2 mk_compclass

=head1 CONFIGURATION AND ENVIRONMENT

 ./script/myapp_create.pl model  Email

You need to specify the C (the name of the model you want to create), and all other elements are optional.

For the  you should add the mailer_args parameters required by the mailer you want to use.

If you want to use an SMTP server, you need to add just SMTP and the address of the SMTP server.

If you want to use an SMTP server that requires authentication, you need to add SMTP, the address of the server, the username and the password, like in the exemple given above.

The module supports the mailers supported by L. Mail::Builder::Simple uses L for sending email, so check the modules under L for finding the parameters you might need to use for each type of mailer.

This helper can add in the model just the mailer type, the hostname, the username and the password, but you can add manually other parameters like a different port than the default, or the option for using SSL when connecting to the SMTP server.

You can add to the generated model any other parameters you can use for sending email, for example the C field, and you won't need to specify those parameters when sending each email.

You can also put the configuration variables in the application's main configuration file (myapp.conf), using something like:


   class Mail::Builder::Simple


       mailer SMTP

         host smtp.host.com
         username myuser
         password mypass


     from [e-mail]



=head1 DIAGNOSTICS

=head1 DEPENDENCIES

L, L, L, L

=head1 INCOMPATIBILITIES

No known incompatibilities.

=head1 BUGS AND LIMITATIONS

No known bugs. If you find some, please announce.

=head1 AUTHOR

Octavian Rasnita C

=head1 LICENSE AND COPYRIGHT

This library is free software. You can redistribute it and/or modify
it under the same terms as perl itself.

No copyright claim is asserted over the generated code.

=cut

1;

__DATA__