NAME
    Apache2::WebApp::Plugin::Mail - Plugin providing mail delivery methods

SYNOPSIS
      my $obj = $c->plugin('Mail')->method( ... );     # Apache2::WebApp::Plugin::Mail->method()

        or

      $c->plugin('Mail')->method( ... );

DESCRIPTION
    Methods for sending template based multi-format e-mail.

PREREQUISITES
    This package is part of a larger distribution and was NOT intended to be
    used directly. In order for this plugin to work properly, the following
    packages must be installed:

      Apache2::WebApp
      MIME::Lite
      MIME::Lite::TT
      MIME::Lite::TT::HTML
      Params::Validate

INSTALLATION
    From source:

      $ tar xfz Apache2-WebApp-Plugin-Mail-0.X.X.tar.gz
      $ perl MakeFile.PL PREFIX=~/path/to/custom/dir LIB=~/path/to/custom/lib
      $ make
      $ make test     <--- Make sure you do this before contacting me
      $ make install

    Perl one liner using CPAN.pm:

      perl -MCPAN -e 'install Apache2::WebApp::Plugin::Mail'

    Use of CPAN.pm in interactive mode:

      $> perl -MCPAN -e shell
      cpan> install Apache2::WebApp::Plugin::Mail
      cpan> quit

    Just like the manual installation of Perl modules, the user may need
    root access during this process to insure write permission is allowed
    within the installation directory.

OBJECT METHODS
  send_text
    Send a template based (text) message.

      $c->plugin('Mail')->send_text( $c,
          {
              from     => 'this@domain.com',
              to       => 'that@domain.com',
              subject  => 'RE: Your subject',
              template => {
                  file => 'msg_body_text.eml',
                  vars => \%tt_hash,
              }
          }
        );

  send_html
    Send a template based (HTML/Text) multi-formatted message.

      $c->plugin('Mail')->send_html( $c, 
          {         
              from     => 'this@domain.com',
              to       => 'that@domain.com,
              subject  => 'RE: Your subject',
              template => {
                  file => { 
                      html => 'msg_body_html.eml',
                      txt  => 'msg_body_text.eml',
                  },        
                  vars => \%tt_hash,
              }         
          }         
        );

SEE ALSO
    Apache2::WebApp, Apache2::WebApp::Plugin, MIME::Lite, MIME::Lite::TT,
    MIME::Lite::TT::HTML

AUTHOR
    Marc S. Brooks, <mbrooks@cpan.org> - <http://mbrooks.info>

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

    See <http://www.perl.com/perl/misc/Artistic.html>

