bamboo

![bamboo](https://user-images.githubusercontent.com/22394/39895001-b13a9c9a-5476-11e8-9c58-f5fc5f09b697.png)

# Bamboo

[![Build](https://github.com/beam-community/bamboo/actions/workflows/ci.yaml/badge.svg)](https://github.com/beam-community/bamboo/actions/workflows/ci.yaml)

---

**This README follows the main branch, which may not be the currently published version!** Use
[the docs for the published version of Bamboo](https://hexdocs.pm/bamboo/readme.html).

---

**Bamboo is now maintained by the [BEAM Community](https://github.com/beam-community)!**

Thank you to [thoughtbot](https://thoughtbot.com) for creating and maintaining Bamboo for so long!

Flexible and easy to use email for Elixir.

- **Built-in support for popular mail delivery services**. Bamboo ships with
  [adapters for several popular mail delivery services, including Mandrill,
  Mailgun, and SendGrid][available-adapters]. It's also quite easy to write
  your own delivery adapter if your platform isn't yet supported.
- **Deliver emails in the background**. Most of the time you don't want or need
  to wait for the email to send. Bamboo makes it easy with
  `Mailer.deliver_later`.
- **A functional approach to mail delivery**. Emails are created, manipulated,
  and sent using plain functions. This makes composition a breeze and fits
  naturally into your existing Elixir app.
- **Unit test with ease**. Bamboo separates email creation and email delivery
  allowing you to test by asserting against email fields without the need for
  special functions.
- **Dead-simple integration tests**. Bamboo provides helper functions to make
  integration testing easy and robust.
- **View sent emails during development**. Bamboo provides a plug you can use
  in your router to view sent emails.
- **Integrate with Phoenix out of the box**. Use Phoenix views and layouts to
  make rendering email easy.

See the [docs] for the most up to date information.

We designed Bamboo to be simple and powerful. If you run into _anything_ that
is less than exceptional, or you just need some help, please open an issue.

## Installation

To install Bamboo, add it to your list of dependencies in `mix.exs`.

```elixir
def deps do
  [{:bamboo, "~> 2.5.1"}] # x-release-please-version
end
```

You may also use the latest code available from main instead of a
published version in hex:

```elixir
def deps do
  [{:bamboo, github: "beam-community/bamboo"}]
end
```

Once you've added Bamboo to your list, update your dependencies by running:

```sh
$ mix deps.get
```

If you are using Elixir < 1.4, also ensure Bamboo is started alongside your
application:

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

## Getting Started

Bamboo separates the tasks of email creation and email sending. To use Bamboo,
you'll need to define one or more email modules (email creation), define a
mailer module (email sending), and provide some configuration.

To create emails, define an email module within your application.

```eli