/bamboo_elastic_email

Primary LanguageElixirOtherNOASSERTION

Bamboo.ElasticEmailAdapter

![Build Status][build_status_svg]

An Elastic Email adapter for the Bamboo email app for Elixir.

Installation

  1. Add bamboo and bamboo_elastic_email to your mix.exs:

    def deps do
  [
    {:bamboo, "~> 0.8"},
    {:bamboo_elastic_email, "~> 0.1"}
    # OR: {:bamboo_elastic_email, github: "KineticCafe/bamboo_elastic_email"}
  ]
end

  2. If using Elixir before 1.4, or if you are managing all applications yourself, ensure that bamboo is started before your application:

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

  3. Add your Elastic Email API key to your config:

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

  4. Follow the Bamboo Getting Started Guide.

  5. To use Elastic Email's API parameters that are not automatically handled by this plug-in natively, you can place a value in the Email#private parameter:

    Email.put_private(email, :elastic_send_options, %{post_back: "your-post-back-value", pool_name: "your-pool-name"})

    Supported parameters are:

    • :attachments
    • :channel
    • :charset_body_html
    • :charset_body_text
    • :data_source
    • :encoding_type
    • :lists
    • :merge
    • :merge_source_filename
    • :pool_name
    • :post_back
    • :segments
    • :template
    • :time_off_set_minutes
    • :track_clicks
    • :track_opens

Community and Contributing

We welcome your contributions, as described in Contributing.md. Like all Kinetic Cafe open source projects, is under the Kinetic Cafe Open Source Code of Conduct.