Skip to content
An API wrapper for the MailChimp STS API (1.0)
Ruby
Pull request Compare This branch is 5 commits ahead, 32 commits behind amro:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
rdoc
test
.document
.gitignore
Gemfile
Gemfile.lock
LICENSE.txt
README.markdown
Rakefile
VERSION
uakari.gemspec

README.markdown

uakari

Uakari is a simple API wrapper for the MailChimp STS API 1.0, which wraps Amazon SES.

Installation

$ gem install uakari

Requirements

A paid MailChimp account, MailChimp API key, and Amazon AWS account with SES ready to go. You can see your API keys here. Caveats include the inability to send to unconfirmed email addresses until you request (and Amazon provides) production access to your AWS account.

Usage

<<<<<<< HEAD Configure your app with your API key:

Uakari.apikey = 'your-api-key'

There are a few ways to use Uakari.

You can create an instance of the API wrapper:

u = Uakari.new("your_api_key")

You can set your api_key globally and call class methods:

Uakari.api_key = "your_api_key"
Uakari.send_email(...)

You can also set the environment variable 'MC_API_KEY' and Uakari will use it when you create an instance:

u = Uakari.new

62b1d4c994213af3b4f313c5f48338527488b37a

Sending a message

Send a message so a single email:

Uakari.send_email({
    :track_opens => true, 
    :track_clicks => true, 
    :tags         => ["awesome", "tags", "here"] #optional STS tags
    :message      => { 
        :subject => 'your subject', 
        :html => '<html>hello world</html>', 
        :text => 'hello world', 
        :from_name => 'John Smith', 
        :from_email => 'support@somedomain.com', 
        :to_email => ['user@someotherdomain.com']
    }
})

Calling other methods is as simple as calling API methods directly on Uakari (e.g. u.get_send_quota, u.verify_email_address, and so on). Check the API documentation for more information about API calls and their parameters.

Plugging into ActionMailer

You can tell ActionMailer to send mail using Mailchimp STS by adding the follow to to your config/application.rb or to the proper environment (eg. config/production.rb) :

config.action_mailer.delivery_method = :uakari
config.action_mailer.uakari_settings = {

<<<<<<< HEAD

:from_name => "From name"

      :api_key => "your_mailchimp_apikey",
      :track_clicks => true,
      :track_opens  => true, 
      :from_name    => "Change Me"
      :tags         => ["awesome", "tags", "here"] #optional STS tags

62b1d4c994213af3b4f313c5f48338527488b37a }

These setting will allow you to use ActionMailer as you normally would, any calls to mail() will be sent using Mailchimp STS

If, for some reason, you want to use ActionMailer and change your tags dynamically at runtime, you can do something like:

ActionMailer::Base.uakari_settings[:tags] = ["dynamically", "set", "tags"]

Other Stuff

Uakari defaults to a 30 second timeout. You can optionally set your own timeout (in seconds) like so:

Uakari.timeout = 5

Thanks

Copyrights

  • Copyright (c) 2010 Amro Mousa. See LICENSE.txt for details.
  • MailChimp (c) 2001-2011 The Rocket Science Group.
  • Amazon SES (c) 2011 Amazon
Something went wrong with that request. Please try again.