# Bamboo.SparkPostAdapter
[![Build Status](https://travis-ci.org/andrewtimberlake/bamboo_sparkpost.svg?branch=master)](https://travis-ci.org/andrewtimberlake/bamboo_sparkpost)

An Adapter for the [Bamboo](https://github.com/thoughtbot/bamboo) email app.

## Installation

The package can be installed as:

  1. Add bamboo_sparkpost to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [{:bamboo_sparkpost, "~> 1.0.0-rc.0"}]
end
```

  2. Ensure bamboo is started before your application:

```elixir
def application do
  [applications: [:bamboo]]
end
```

  3. Add your SparkPost API key to your config

```elixir
# In your config/config.exs file
config :my_app, MyApp.Mailer,
  adapter: Bamboo.SparkPostAdapter
  api_key: "my-api-key"
```

  4. Follow Bamboo [Getting Started Guide](https://github.com/thoughtbot/bamboo#getting-started)

## Advanced Usage

The SparkPost adapter provides a helper module for setting tags and other meta data

### Examples

```elixir
include Bamboo.SparkPostHelper

email
|> tag("my-tag")
|> mark_transactional
|> disable_open_tracking
|> disable_click_tracking
|> meta_data(foo: "bar")
```