.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Catalyst::View::Email 3"
.TH Catalyst::View::Email 3 "2007-05-19" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Catalyst::View::Email \- Send Email from Catalyst
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This module simply sends out email from a stash key specified in the
configuration settings.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
In your app configuration (example in \s-1YAML\s0):
    View::Email:
        stash_key: email
        content_type: text/plain 
        sender:
            method:     \s-1SMTP\s0
            # mailer_args is passed directly into Email::Send 
            mailer_args:
                \- Host:       smtp.example.com
                \- username:   username
                \- password:   password
.SH "SENDING EMAIL"
.IX Header "SENDING EMAIL"
In your controller, simply forward to the view after populating the \f(CW\*(C`stash_key\*(C'\fR
.PP
.Vb 10
\&    sub controller : Private {
\&        my ( $self, $c ) = @_;
\&        $c->stash->{email} = {
\&            to      => q{catalyst@rocksyoursocks.com},
\&            from    => q{no-reply@socksthatarerocked.com},
\&            subject => qq{Your Subject Here},
\&            body    => qq{Body Body Body}
\&        };
\&        $c->forward('View::Email');
\&    }
.Ve
.PP
Alternatively, you can use a more raw interface, and specify the headers as
an array reference.
.PP
.Vb 18
\&    $c->stash->{email} = {
\&        header => [
\&            To      => 'foo@bar.com',
\&            Subject => 'Note the capitalization differences'
\&        ],
\&        body => qq{Ain't got no body, and nobody cares.},
\&        # Or, send parts
\&        parts => [
\&            Email::MIME->create(
\&                attributes => {
\&                    content_type => 'text/plain',
\&                    disposition  => 'attachment',
\&                    charset      => 'US-ASCII',
\&                },
\&                body => qq{Got a body, but didn't get ahead.}
\&            )
\&        ],
\&    };
.Ve
.SH "HANDLING FAILURES"
.IX Header "HANDLING FAILURES"
If the email fails to send, the view will die (throw an exception).  After
your forward to the view, it is a good idea to check for errors:
.PP
.Vb 7
\&    $c->forward('View::Email');
\&    if ( scalar( @{ $c->error } ) ) {
\&        $c->error(0); # Reset the error condition if you need to
\&        $c->res->body('Oh noes!');
\&    } else {
\&        $c->res->body('Email sent A-OK! (At least as far as we can tell)');
\&    }
.Ve
.SH "OTHER MAILERS"
.IX Header "OTHER MAILERS"
Now, it's no fun to just send out email using plain strings.  We also have
Catalyst::View::Email::TT for use.  You can also toggle this as being used
by setting up your configuration to look like this:
.PP
.Vb 2
\&    View::Email:
\&        default: TT
.Ve
.PP
Then, Catalyst::View::Email will forward to View::Email::TT by default.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Sh "Catalyst::View::Email::Template \- Send fancy template emails with Cat"
.IX Subsection "Catalyst::View::Email::Template - Send fancy template emails with Cat"
.Sh "Catalyst::Manual \- The Catalyst Manual"
.IX Subsection "Catalyst::Manual - The Catalyst Manual"
.Sh "Catalyst::Manual::Cookbook \- The Catalyst Cookbook"
.IX Subsection "Catalyst::Manual::Cookbook - The Catalyst Cookbook"
.SH "AUTHORS"
.IX Header "AUTHORS"
J. Shirley <jshirley@gmail.com>
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.