sendgrid v2.0.0 SendGrid.Mail View Source

Module for sending transactional email.

Sandbox Mode

Sandbox mode allows you to test sending emails without actually delivering emails and using your email quota.

To send emails in sandbox mode, ensure the config key is set:

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

Optionally, you can use SendGrid.Email.set_sandbox/2 to configure it per email.

Link to this section Summary

Functions

send(email, opts \\ [])

Sends the built email

Link to this section Functions

send(email, opts \\ [])

send(SendGrid.Email.t(), [SendGrid.api_key()]) ::
  :ok | {:error, [String.t()]} | {:error, String.t()}

Sends the built email.

Options

:api_key - API key to use with the request.

Examples

email =
  Email.build()
  |> Email.add_to("test@email.com")
  |> Email.put_from("test2@email.com")
  |> Email.put_subject("Hello from Elixir")
  |> Email.put_text("Sent with Elixir")

:ok = Mail.send(email)