Awesome

Mailchimp Transactional — Ruby

The official Ruby client library for the Mailchimp Transactional API (v1)

Installation

Build a gem

To build the Ruby code into a gem:

gem build MailchimpTransactional.gemspec

Then either install the gem locally:

gem install ./MailchimpTransactional-1.0.59.gem

(for development, run gem install --dev ./MailchimpTransactional-1.0.59.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'MailchimpTransactional', '~> 1.0.59'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/mailchimp/mailchimp-transactional-ruby, then add the following in the Gemfile:

gem 'MailchimpTransactional', :git => 'https://github.com/mailchimp/mailchimp-transactional-ruby.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Quick Start

require 'MailchimpTransactional'

begin
  client = MailchimpTransactional::Client.new('YOUR_API_KEY')
  resp = client.users.ping
  p resp
rescue MailchimpTransactional::ApiError => e
  puts "Error: #{e}"
end

Sending Requests

All requests are sent via POST and accept a single argument as the request body parameter.

client.templates.publish({ name:'My Template' });

Output Formats

Optionally, you can set the default response format for all requests to one of the following:

• json (default)
• xml
• php
• yaml

client.set_default_output_format('xml');

You can also set the response format for a single request by passing in a special outputFormat param to the request body.

client.senders.list({ outputFormat: 'php' });

PRs and Issues

This repo is autogenerated from https://github.com/mailchimp/mailchimp-client-lib-codegen -- please submit PRs or issues there!

API Endpoints

All URIs are relative to https://mandrillapp.com/api/1.0

Additional Libraries

Mailchimp Transactional libraries are available in the following languages: