Catalyst::Plugin::Email man page on Fedora

Man page or keyword search:  
man Server   31170 pages
apropos Keyword Search (all sections)
Output format
Fedora logo
[printable version]

Email(3)	      User Contributed Perl Documentation	      Email(3)

NAME
       Catalyst::Plugin::Email - Send emails with Catalyst

SYNOPSIS
	   use Catalyst 'Email';

	   __PACKAGE__->config->{email} = [qw/SMTP smtp.oook.de/];

	   $c->email(
	       header => [
		   From	   => 'sri@oook.de',
		   To	   => 'sri@cpan.org',
		   Subject => 'Hello!'
	       ],
	       body => 'Hello sri'
	   );

DESCRIPTION
       Send emails with Catalyst and Email::Send and Email::MIME::Creator.

CONFIGURATION
       "config" accepts the same options as Email::Send.

       To send using the system's "sendmail" program, set "config" like so:

	   __PACKAGE__->config->{email} = ['Sendmail'];

       To send using authenticated SMTP:

	   __PACKAGE__->config->{email} = [
	       'SMTP',
	       'smtp.myhost.com',
	       username => $USERNAME,
	       password => $PASSWORD,
	   ];

       For different methods of sending emails, and appropriate "config"
       options, see Email::Send::NNTP, Email::Send::Qmail, Email::Send::SMTP
       and Email::Send::Sendmail.

METHODS
   email
       "email()" accepts the same arguments as Email::MIME::Creator's
       "create()".

	   $c->email(
	       header => [
		   To	   => 'me@localhost',
		   Subject => 'A TT Email',
	       ],
	       body => $c->subreq( '/render_email' ),
	   );

       To send a multipart message, include a "parts" argument containing an
       arrayref of Email::MIME objects.

	   my @parts = (
	       Email::MIME->create(
		   attributes => {
		       content_type => 'application/pdf',
		       encoding	    => 'quoted-printable',
		       name	    => 'report.pdf',
		   },
		   body => $FILE_DATA,
	       ),
	       Email::MIME->create(
		   attributes => {
		       content_type => 'text/plain',
		       disposition  => 'attachment',
		       charset	    => 'US-ASCII',
		   },
		   body => $c->subreq( '/render_email' ),
	       ),
	   );

	   $c->email(
	       header => [
		   To	   => 'me@localhost',
		   Subject => 'A TT Email',
	       ],
	       parts => \@parts,
	   );

USING WITH A VIEW
       A common practice is to handle emails using the same template language
       used for HTML pages.  If your view supports the 'render' method (Like
       the TT view does), you just set the body like this:
	 $c->email(
	    header => [
	       To      => 'me@localhost',
	       Subject => 'A TT Email',
	    ],
	    body => $c->view('TT')->render($c,'mytemplate.tt'),
	 }

       If your view doesn't support render, you can just forward to it, then
       reset the body like this:

	   sub send_email : Local {
	       my ( $self, $c ) = @_;
	       {
	       local $c->stash->{names}	  = [ qw/andyg sri mst/ ],
	       local $c->stash->{template}= 'mytemplate.tt';
	       $c->forward($c->view('MyView'));
	       $c->email(
		   header => [
		       To      => 'me@localhost',
		       Subject => 'A TT Email',
		   ],
		   body => $c->res->body,
	       );
	       $c->res->body(undef);
	       }
	   }

       And the template:

	   [%- FOREACH name IN names -%]
	   Hi, [% name %]!
	   [%- END -%]

	   --
	   Regards,
	   Us

       Output:

	   Hi, andyg!
	   Hi, sri!
	   Hi, mst!

	   --
	   Regards,
	   Us

SEE ALSO
       Catalyst, Catalyst::Plugin::SubRequest, Email::Send,
       Email::MIME::Creator

AUTHOR
       Sebastian Riedel, "sri@cpan.org" Andy Grundman Carl Franks Marcus
       Ramberg "mramberg@cpan.org"

COPYRIGHT
       This program is free software, you can redistribute it and/or modify it
       under the same terms as Perl itself.

perl v5.14.1			  2006-12-31			      Email(3)
[top]

List of man pages available for Fedora

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net