digitalocean/sample-functions-python-sendgrid-email

digitalocean/sample-functions-python-sendgrid-email

Description: Sending emails via Sendgrid API

Language: Python

Stars: 23

Forks: 27

Open issues: 3

Created: 2022-07-11T19:35:33Z

Pushed: 2022-10-03T12:05:27Z

Default branch: main

Fork: no

Archived: no

README:

Sample Function: Python "Sendgrid Emails"

Introduction

This repository contains a sample Sendgrid Email function written in Python. You are able to send an email using Sendgrid's API to email addresses with or without DMARCS. You can deploy it on DigitalOcean's App Platform as a Serverless Function component. Documentation is available at https://docs.digitalocean.com/products/functions.

Requirements

• You need a DigitalOcean account. If you don't already have one, you can sign up at https://cloud.digitalocean.com/registrations/new.
• You need a SendGrid account. If you don't already have one, you can sign up at https://signup.sendgrid.com/.
• You need to create a SendGrid API key with Full Access to connect to your sendgrid account. You can learn more about it at https://docs.sendgrid.com/ui/account-and-settings/api-keys.
• You need to add your API_KEY to the .env file to connect to the SendGrid API.
• To send emails with valid email addresses, you have to set up sender authentication. You can learn more at https://docs.sendgrid.com/glossary/sender-authentication.
• To send emails to email address with DMARCS, you have to set up domain authentication. You can learn more at https://docs.sendgrid.com/ui/account-and-settings/how-to-set-up-domain-authentication.
• To deploy from the command line, you will need the DigitalOcean `doctl` CLI.

Deploying the Function

# clone this repo
git clone git@github.com:digitalocean/sample-functions-python-sendgrid-email.git

# deploy the project, using a remote build so that compiled executable matched runtime environment
> doctl serverless deploy sample-functions-python-sendgrid-email --remote-build
Deploying 'sample-functions-python-sendgrid-email'
to namespace 'fn-...'
on host 'https://faas-...'
Submitted action 'emails' for remote building and deployment in runtime python:default (id: ...)

Deployed functions ('doctl sls fn get --url' for URL):
- sample/emails

Using the Function

doctl serverless functions invoke sample/emails -p from:user@do.com to:user@gmail.com subject:Sammy content:Good Morning from Sammy.

{
"body": "email sent"
}

To send an email using curl:

curl -X PUT -H 'Content-Type: application/json' {your-DO-app-url} -d '{"from":"user@do.com", "to":"user@gmail.com", "subject": "Sammy", "content":"Good Morning from Sammy!"}'

Learn More

You can learn more about Functions and App Platform integration in the official App Platform Documentation.