Packages

bamboo

0.5.0
2.5.0 2.4.0 2.3.1 2.3.0 2.2.0 2.1.0 2.0.2 2.0.1 2.0.0 1.7.1 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 1.0.0-rc.3 1.0.0-rc.2 1.0.0-rc.1 0.8.0 0.7.0 0.6.0 0.5.0 0.4.2 0.4.1 0.4.0 0.3.2 0.3.1 0.3.0 0.2.0 0.0.1

Straightforward, powerful, and adapter based Elixir email library. Works with Mandrill, Mailgun, SendGrid, SparkPost, Postmark, in-memory, and test.

HexDocs

Current section

Files

Jump to
Readme
33 Versions
3 Dependencies
Dependants
Files
Activity
bamboo lib bamboo adapter.ex
Raw

lib/bamboo/adapter.ex 

defmodule Bamboo.Adapter do

  @moduledoc ~S"""

  Behaviour for creating Bamboo adapters



  All recipients in the Bamboo.Email struct will be normalized to a 2 item tuple

  of {name, address} when deliver through your mailer. For example,

  `email.from |> elem(0)` would return the name and `email.from |> elem(1)`

  would return the email address.



  For more in-depth examples check out the

  [adapters in Bamboo](https://github.com/paulcsmith/bamboo/tree/master/lib/bamboo/adapters).



  ## Example



      defmodule Bamboo.CustomAdapter do

        @behaviour Bamboo.Adapter



        def deliver(email, config) do

          deliver_the_email_somehow(email)

        end



        def handle_config(config) do

          # Return the config if nothing special is required

          config



          # Or you could require certain config options

          if Map.get(config, :smtp_username) do

            config

          else

            raise "smtp_username is required in config, got #{inspect config}"

          end

        end

      end

  """



  @callback deliver(%Bamboo.Email{}, %{}) :: any

  @callback handle_config(map) :: map

end