GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CATALYST::PLUGIN::EMAIL (3)

.ds Aq ’

NAME

Catalyst::Plugin::Email - (DEPRECATED) Send emails with Catalyst

CONTENTS

SYNOPSIS



    # please use Email::MIME::Kit or Catalyst::View::Email::Template instead

    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.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 CATALYST::PLUGIN::EMAIL (3) 2015-08-12

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.