Giter Site home page Giter Site logo

sendgrid_elixir's Introduction

SendGrid

A wrapper for SendGrid's API to create composable emails.

Installation

Add the following code to your dependencies in your mix.exs file:

{:sendgrid, "~> 1.4.0"}

Configuration

In one of your configuration files, include your SendGrid API key like this:

config :sendgrid,
  api_key: "SENDGRID_API_KEY"

If you'd like to enable sandbox mode (emails won't send but will be validated), add the setting to your config:

config :sendgrid,
  api_key: "SENDGRID_API_KEY",
  sandbox_enable: true

Add :sendgrid to your list of applications

defp application do
  [applications: [:sendgrid]]
end

Usage

Check the docs for complete usage.

Simple Text Email

alias SendGrid.{Mailer, Email}

email = 
  Email.build()
  |> Email.put_from("[email protected]")
  |> Email.add_to("[email protected]")
  |> Email.put_subject("Hello From Elixir")
  |> Email.put_text("Sent from Elixir!")
  
Mailer.send(email)

Simple HTML Email

alias SendGrid.{Mailer, Email}

email = 
  Email.build()
  |> Email.put_from("[email protected]")
  |> Email.add_to("[email protected]")
  |> Email.put_subject("Hello From Elixir")
  |> Email.put_html("<html><body><p>Sent from Elixir!</p></body></html>")
  
Mailer.send(email)

Using a Predefined Template

alias SendGrid.{Mailer, Email}

email = 
  Email.build()
  |> Email.put_template("the_template_id")
  |> Email.add_substitution("-foo-", "bar")
  |> Email.put_html("<span>Some Text</span>")
  
Mailer.send(email)

sendgrid_elixir's People

Contributors

alexgaribay avatar overallduka avatar gullitmiranda avatar bkono avatar joshbeckman avatar h4cc avatar silbermm avatar luki3k5 avatar tulinmola avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.