Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 689 Commits
.github/workflows		.github/workflows
examples		examples
helpers		helpers
proposal		proposal
static/img		static/img
use-cases		use-cases
.env_sample		.env_sample
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
FIRST_TIMERS.md		FIRST_TIMERS.md
LICENSE		LICENSE
Makefile		Makefile
PULL_REQUEST_TEMPLATE.md		PULL_REQUEST_TEMPLATE.md
README.md		README.md
TROUBLESHOOTING.md		TROUBLESHOOTING.md
USAGE.md		USAGE.md
base_interface.go		base_interface.go
go.coverage.sh		go.coverage.sh
sendgrid.go		sendgrid.go
sendgrid_test.go		sendgrid_test.go
twilio_email.go		twilio_email.go
twilio_email_test.go		twilio_email_test.go
twilio_sendgrid_logo.png		twilio_sendgrid_logo.png

Repository files navigation

This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via Go.

Version 3.X.X of this library provides full support for all Twilio SendGridWeb API v3 endpoints, including the newv3 /mail/send.

This library represents the beginning of a new path for Twilio SendGrid. We want this library to be community driven and Twilio SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you createissues andpull requests or simply upvote or comment on existing issues or pull requests.

If you need help using SendGrid, please check theTwilio SendGrid Support Help Center.

Installation

Supported Versions

This library supports the following Go implementations:

Go 1.14
Go 1.15
Go 1.16
Go 1.17
Go 1.18
Go 1.19

Prerequisites

The Twilio SendGrid service, starting at thefree level, to send up to 40,000 emails for the first 30 days, then send 100 emails/day free forever or check outour pricing.

Setup Environment Variables

Update the development environment with yourSENDGRID_API_KEY, for example:

echo"export SENDGRID_API_KEY='YOUR_API_KEY'"> sendgrid.envecho"sendgrid.env">> .gitignoresource ./sendgrid.env

Install Package

go get github.com/sendgrid/sendgrid-go

Dependencies

rest

Setup Environment Variables

Initial Setup

cp .env_sample .env

Environment Variable

Update the development environment with yourSENDGRID_API_KEY, for example:

echo"export SENDGRID_API_KEY='YOUR_API_KEY'"> sendgrid.envecho"sendgrid.env">> .gitignoresource ./sendgrid.env

Quick Start

Hello Email

The following is the minimum needed code to send an email with the/mail/send Helper (here is a full example):

With Mail Helper Class

package mainimport ("fmt""log""os""github.com/sendgrid/sendgrid-go""github.com/sendgrid/sendgrid-go/helpers/mail")funcmain() {from:=mail.NewEmail("Example User","test@example.com")subject:="Sending with Twilio SendGrid is Fun"to:=mail.NewEmail("Example User","test@example.com")plainTextContent:="and easy to do anywhere, even with Go"htmlContent:="<strong>and easy to do anywhere, even with Go</strong>"message:=mail.NewSingleEmail(from,subject,to,plainTextContent,htmlContent)client:=sendgrid.NewSendClient(os.Getenv("SENDGRID_API_KEY"))response,err:=client.Send(message)iferr!=nil {log.Println(err)}else {fmt.Println(response.StatusCode)fmt.Println(response.Body)fmt.Println(response.Headers)}}

TheNewEmail constructor creates apersonalization object for you.Here is an example of how to add to it.

Without Mail Helper Class

The following is the minimum needed code to send an email without the /mail/send Helper (here is a full example):

package mainimport ("fmt""github.com/sendgrid/sendgrid-go""log""os")funcmain() {request:=sendgrid.GetRequest(os.Getenv("SENDGRID_API_KEY"),"/v3/mail/send","https://api.sendgrid.com")request.Method="POST"request.Body= []byte(` {"personalizations": [{"to": [{"email": "test@example.com"}],"subject": "Sending with Twilio SendGrid is Fun"}],"from": {"email": "test@example.com"},"content": [{"type": "text/plain","value": "and easy to do anywhere, even with Go"}]}`)response,err:=sendgrid.API(request)iferr!=nil {log.Println(err)}else {fmt.Println(response.StatusCode)fmt.Println(response.Body)fmt.Println(response.Headers)}}

General v3 Web API Usage

package mainimport ("fmt""github.com/sendgrid/sendgrid-go""log""os")funcmain() {request:=sendgrid.GetRequest(os.Getenv("SENDGRID_API_KEY"),"/v3/api_keys","https://api.sendgrid.com")request.Method="GET"response,err:=sendgrid.API(request)iferr!=nil {log.Println(err)}else {fmt.Println(response.StatusCode)fmt.Println(response.Body)fmt.Println(response.Headers)}}