redsquirrel / mad_mimi_mailer

Use Mad Mimi to send beautiful HTML emails using the ActionMailer API

This URL has Read+Write access

Dave Hoover (author)
Tue Oct 20 06:45:22 -0700 2009
commit  d7322687c9ab1a4cb6d8faa1c6e1e9d12cee5f2a
tree    1c34a1b5252a1c1f7742b40e16895a2e3719c472
parent  d735e4538775a78aa1b6ebed91adfeb82fcfe555
mad_mimi_mailer / README.rdoc
100644 93 lines (67 sloc) 2.883 kb

Mad Mimi Mailer

DESCRIPTION:

Let Mad Mimi handle your HTML emails. This is a drop-in replacement for ActionMailer. MadMimiMailer extends ActionMailer::Base, so you can intermingle normal ActionMailer emails with emails sent via Mad Mimi. Just start your Mad Mimi-specific emails with deliver_mimi_foo and it will send your Mad Mimi promotion named "foo". Oh, and it will also automatically import the recipient into your Mad Mimi account.

TODO:

  • If something goes wrong with the call to Mad Mimi, fallback and use plain old local Rails templates.
  • Document how body data can be used in Mad Mimi templates
  • Document promotion, hidden, and use_erb options

SYNOPSIS:

  class UserNotifier < MadMimiMailer
    def mimi_welcome(user)
      subject "Welcome to WidgetHub"
      recipients user.email
      bcc ADMIN_PEEPS
      from "admin@example.com"
      body :username => user.name, :email => user.email, :password => user.password
    end

    def reset(user)
      subject "Resetting your WidgetHub account"
      recipients user.email
      bcc ADMIN_PEEPS
      from "admin@example.com"
      body :user => user
    end
  end

  MadMimiMailer.api_settings = {
    :username => 'dave@example.com',
    :api_key => '75a6c6f1SomeFakeApiKeycbcc300'
  }

  user = User.first

  # Sent via Mad Mimi
  UserNotifier.deliver_mimi_welcome(user)

  # Sent via good old ActionMailer
  UserNotifier.deliver_reset(user)

REQUIREMENTS:

  • A Mad Mimi account with Mailer API enabled
  • ActionMailer

INSTALL:

  • sudo gem install gemcutter
  • gem tumble
  • sudo gem install mad_mimi_mailer

LICENSE:

  (The MIT License)

  Copyright (c) 2009 Dave Hoover, Obtiva Corporation

  Permission is hereby granted, free of charge, to any person obtaining
  a copy of this software and associated documentation files (the
  'Software'), to deal in the Software without restriction, including
  without limitation the rights to use, copy, modify, merge, publish,
  distribute, sublicense, and/or sell copies of the Software, and to
  permit persons to whom the Software is furnished to do so, subject to
  the following conditions:

  The above copyright notice and this permission notice shall be
  included in all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.