Swoosh.Adapters.Sendgrid (Swoosh v1.3.3) View Source

An adapter that sends email using the Sendgrid API.

For reference: Sendgrid API docs


# config/config.exs
config :sample, Sample.Mailer,
  adapter: Swoosh.Adapters.Sendgrid,
  api_key: "my-api-key"

# lib/sample/mailer.ex
defmodule Sample.Mailer do
  use Swoosh.Mailer, otp_app: :sample

Provider Options

Supported provider options are the following:

Inserted into personalization

  • :custom_args
  • :substitutions
  • :dynamic_template_data

Inserted into request body

  • :template_id
  • :asm
  • :categories
  • :mail_settings
  • :tracking_settings

Sandbox mode

For sandbox mode, use put_provider_option/3:

iex> new() |> put_provider_option(:mail_settings, %{sandbox_mode: %{enable: true}})

Link to this section Summary

Link to this section Functions

Callback implementation for Swoosh.Adapter.validate_config/1.

Callback implementation for Swoosh.Adapter.validate_dependency/0.