/ 
Catalyst-Helper-Model-Email-0.01
River stage zero No dependents
/ Catalyst::Helper::Model::Email

NAME

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

SYNOPSIS

Running:

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

Will create MyApp::Model::Email1 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 in your controllers just:

$c->model("Email1"->send(
 from => 'me@host.com',
 to => 'you@yourhost.com',
 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 => ['me@host.com', 'My Name'],
 to => ['you@yourhost.com', 'Your Name'],
 subject => 'The subject with UTF-8 chars',
 plaintext => "Hello\n\nHow are you?\n\n",
 htmltext => "<h1>Hello</h1> <p>How are you?</p>",
 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.

ARGUMENTS

./script/myapp_create.pl model <model_name> Email <mailer_args>

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

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

If you want to use Sendmail (which is the default), you don't need to add any parameters for <mailer_args>, or you could add just Sendmail.

If you want to use qmail as a mailer, you need to add Qmail.

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.

If you want to send email with Gmail email provider, you need to use Gmail, then the username and the password.

If you want to use NNTP, you need to add NNTP, the address of the server, the username and the password.

The module supports all the mailers supported by Mail::Builder::Simple.

You can add to the generated model any other parameters you can use for sending email, for example the From: 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:

<Model::Email1>
 class Mail::Builder::Simple
 <args>
  <mail_client>
   mailer SMTP
   <mailer_args>
    Host smtp.host.com
    username myuser
    password mypass
   </mailer_args>
  </mail_client>
  from me@host.com
 </args>
</Model::Email1>

SEE ALSO

Catalyst, Mail::Builder::Simple

AUTHOR

Octavian Rasnita orasnita@gmail.com

LICENSE

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.