sendgrid

README

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

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

Version 3.X.X of this library provides full support for all SendGrid Web API v3 endpoints, including the new v3 /mail/send.

This library represents the beginning of a new path for SendGrid. We want this library to be community driven and 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
• Quick Start
• Processing Inbound Email
• Usage
• Use Cases
• Announcements
• Roadmap
• How to Contribute
• Troubleshooting
• About

Installation

Prerequisites

• Go version 1.6
• The SendGrid service, starting at the free level

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

• rest

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", "dx@sendgrid.com")
	subject := "Sending with SendGrid is Fun"
	to := mail.NewEmail("Example User", "elmer.thomas@sendgrid.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 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

• SendGrid Docs
• Library Usage Docs
• Example Code
• How-to: Migration from v2 to v3
• v3 Web API Mail Send Helper

Use Cases

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

Announcements

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

All updates to this library is documented in our CHANGELOG and releases.

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:

• Feature Request
• Bug Reports
• Sign the CLA to Create a Pull Request
• Improvements to the Codebase

Troubleshooting

Please see our troubleshooting guide for common library issues.

About

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

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

Documentation

Overview

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

Index

• Constants
• Variables
• func API(request rest.Request) (*rest.Response, error)
• func GetRequest(key string, endpoint string, host string) rest.Request
• type Client
  • func NewSendClient(key string) *Client
  • func (cl *Client) Send(email *mail.SGMailV3) (*rest.Response, error)

Constants

const Version = "3.1.0"

Version is this client library's current version

Variables

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 SendGrid API, this is main interface.

func GetRequest

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

GetRequest returns a default request object.

Types

type Client

type Client struct {
	rest.Request
}

func NewSendClient

func NewSendClient(key string) *Client

func (*Client) Send

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