sendgrid

package module
v3.5.12+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 29, 2020 License: MIT Imports: 6 Imported by: 0

README

Twilio SendGrid Logo

BuildStatus Email Notifications Badge GoDoc MIT licensed Twitter Follow GitHub contributors Open Source Helpers

NEW: Subscribe to email notifications for releases and breaking changes.

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 SendGrid Web API v3 endpoints, including the new v3 /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 create issues and pull requests or simply upvote or comment on existing issues or pull requests.

Please browse the rest of this README for further detail.

We appreciate your continued support, thank you!

Table of Contents

Installation

Prerequisites

  • Go version 1.6
  • The Twilio SendGrid service, starting at the free level, to send up to 40,000 emails for the first 30 days, then send 100 emails/day free forever or check out our pricing.

Setup Environment Variables

Update the development environment with your SENDGRID_API_KEY, for example:

echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env

Install Package

go get github.com/sendgrid/sendgrid-go

Dependencies

Setup Environment Variables

Initial Setup
cp .env_sample .env
Environment Variable

Update the development environment with your SENDGRID_API_KEY, for example:

echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./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 main

import (
	"fmt"
	"log"
	"os"

	"github.com/sendgrid/sendgrid-go"
	"github.com/sendgrid/sendgrid-go/helpers/mail"
)

func main() {
	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)
	if err != nil {
		log.Println(err)
	} else {
		fmt.Println(response.StatusCode)
		fmt.Println(response.Body)
		fmt.Println(response.Headers)
	}
}

The NewEmail constructor creates a personalization 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 main

import (
	"fmt"
	"github.com/sendgrid/sendgrid-go"
	"log"
	"os"
)

func main() {
	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)
	if err != nil {
		log.Println(err)
	} else {
		fmt.Println(response.StatusCode)
		fmt.Println(response.Body)
		fmt.Println(response.Headers)
	}
}

General v3 Web API Usage

package main

import (
	"fmt"
	"github.com/sendgrid/sendgrid-go"
	"log"
	"os"
)

func main() {
	request := sendgrid.GetRequest(os.Getenv("SENDGRID_API_KEY"), "/v3/api_keys", "https://api.sendgrid.com")
	request.Method = "GET"

	response, err := sendgrid.API(request)
	if err != nil {
		log.Println(err)
	} else {
		fmt.Println(response.StatusCode)
		fmt.Println(response.Body)
		fmt.Println(response.Headers)
	}
}

Processing Inbound Email

Please see our helper for utilizing our Inbound Parse webhook.

Usage

Use Cases

Examples of common API use cases, such as how to send an email with a transactional template.

Announcements

Join an experienced and passionate team that focuses on making an impact. Opportunities abound to grow the product - and grow your career!

Please see our announcement regarding breaking changes. Your support is appreciated!

All updates to this library are documented in our CHANGELOG and releases. You may also subscribe to email release notifications for releases and breaking changes.

Roadmap

If you are interested in the future direction of this project, please take a look at our open issues and pull requests. We would love to hear your feedback.

How to Contribute

We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.

Quick links:

Troubleshooting

Please see our troubleshooting guide for common library issues.

About

sendgrid-go is guided and supported by the Twilio SendGrid Developer Experience Team.

sendgrid-go is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-go are trademarks of Twilio SendGrid, Inc.

License

The MIT License (MIT)

Documentation

Overview

Package sendgrid provides a simple interface to interact with the Twilio SendGrid API

Index

Constants

View Source 
const (
	Version = "3.1.0"
)

Version is this client library's current version

Variables

View Source 
var DefaultClient = rest.DefaultClient

DefaultClient is used if no custom HTTP client is defined

Functions

func API 

func API(request rest.Request) (*rest.Response, error)

API sets up the request to the Twilio SendGrid API, this is main interface. Please use the MakeRequest or MakeRequestAsync functions instead. (deprecated)

func APIWithTimeout 

func APIWithTimeout(request rest.Request, timeout time.Duration) (*rest.Response, error)

func GetRequest 

func GetRequest(key, endpoint, host string) rest.Request

GetRequest @return [Request] a default request object

func GetRequestSubuser 

func GetRequestSubuser(key, endpoint, host, subuser string) rest.Request

GetRequestSubuser like GetRequest but with On-Behalf of Subuser @return [Request] a default request object

func MakeRequest 

func MakeRequest(request rest.Request) (*rest.Response, error)

MakeRequest attempts a Twilio SendGrid request synchronously.

func MakeRequestAsync 

func MakeRequestAsync(request rest.Request) (chan *rest.Response, chan error)

MakeRequestAsync attempts a request asynchronously in a new go routine. This function returns two channels: responses and errors. This function will retry in the case of a rate limit.

func MakeRequestRetry 

func MakeRequestRetry(request rest.Request) (*rest.Response, error)

MakeRequestRetry a synchronous request, but retry in the event of a rate limited response.

Types

type Client 

type Client struct {
	// rest.Request
	rest.Request
}

Client is the Twilio SendGrid Go client

func NewSendClient 

func NewSendClient(key string) *Client

NewSendClient constructs a new Twilio SendGrid client given an API key

func NewSendClientSubuser 

func NewSendClientSubuser(key, subuser string) *Client

GetRequestSubuser like NewSendClient but with On-Behalf of Subuser @return Client

func (*Client) Send 

func (cl *Client) Send(email *mail.SGMailV3) (*rest.Response, error)

Send sends an email through Twilio SendGrid

Source Files

View all Source files

Directories

Path Synopsis
examples/apikey command
examples/mail command
examples/stats command
examples
accesssettings command
alerts command
apikeys command
asm command
browsers command
campaigns command
categories command
clients command
contactdb command
devices command
geo command
helpers/mail command
ips command
mail command
mailboxproviders command
mailsettings command
partnersettings command
scopes command
senders command
stats command
subusers command
suppression command
templates command
trackingsettings command
user command
whitelabel command
helpers
inbound command
mail

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.