SendGrid

This package lets you generate and send emails to people using SendGrid. This is currently a simple wrapper around the /mail/send SendGrid v3 API call. If there is something more you need, explain your use case here.

Note that you cannot use this package to send emails from a browser. You'll be blocked by CORS exceptions. You have to run this server-side or from a stand alone application.

Getting started

Set up a SendGrid account

Before you can use this package you need a SendGrid API key. To do this signup for a SendGrid account.

Then after you've logged in, click on the settings tab, then API Keys, and finally "Create API Key". You'll get to choose if the API key has Full Access, Restricted Access, or Billing Access. For this package it's best if you select restricted access and then set Mail Send to Full Access and leave everything else as No Access.

Once you've done this you'll be given an API key. Store it in a password manager or something for safe keeping. You are highly recommended to not hard code the API key into your source code!

Example code

Once you've completed the previous step you can write something like this to send out emails (again, this will not work in a browser client due to CORS).

import SendGrid
import String.Nonempty
import List.Nonempty

sendAnEmailToMe : (Result SendGrid.Error () -> msg) -> SendGrid.ApiKey -> Cmd msg
sendAnEmailToMe msg apiKey = 
    SendGrid.sendEmail 
        msg
        apiKey
        --The subject and content cannot be empty. String.Nonempty.Nonempty ensures that is the case (in a pretty clunky way).
        { subject = String.Nonempty.Nonempty 'S' "ubject" 
        , content = SendGrid.textContent (String.Nonempty.Nonempty 'E' "xample content")
        , to = List.Nonempty.fromElement "your-email@address.com"
        , from = { email = "this-can-be-anything@test.com", name = "test name" }
        , cc = []
        , bcc = []
        }