Sendgrid - CDCgov/prime-simplereport GitHub Wiki

SendGrid

About

SendGrid is a cloud-based SMTP provider that allows us to send emails in our app.

We use SendGrid to send emails for test results or when a patient bulk upload has successfully completed.

Enabling SendGrid in Envs

By default, many of the lower environments have SendGrid turned off. To turn on SendGrid in the lower environments for testing purposes, do the following:

  1. In backend/src/main/resources/ edit the yaml file for the environment you are hoping to enable SendGrid. (For example, if you wanted to enable SendGrid on dev5 you would edit the application-azure-dev5.yaml file.

  2. In the file, set sendgrid enabled value to true.

  3. Deploy the change, to the lower environment of your choice.

  4. Be sure to turn off SendGrid once you are done testing. Example here of how that is done.

Looking for something else?

  • If you were looking for how to setup sending emails locally, see MailHog.

  • If you were looking for how our app sends SMS messages, see Twilio.