/smtpapi-go

SendGrids smtpapi library in Golang

Primary LanguageGoMIT LicenseMIT

SendGrid Logo

BuildStatus MIT licensed Twitter Follow GitHub contributors Go Report Card GoDoc

This is a simple library to simplify the process of using SendGrid's X-SMTPAPI with the Go programming language

Table of Contents

Announcements

The default branch name for this repository has been changed to main as of 07/27/2020.

All the updates to this library are documented in our CHANGELOG.

Installation

Supported Versions

  • Go version 1.11-1.16

Prerequisites

  • The SendGrid service, starting at the free level

Install the Package

go get github.com/sendgrid/smtpapi-go

Setup the Environment Variables

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

package main

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

func main() {
  header := smtpapi.NewSMTPAPIHeader()
  header.AddTo("test@example.com")
  fmt.Println(header.JSONString())
}

Usage

How to Contribute

We encourage contribution to our libraries, please see our CONTRIBUTING guide for more details on contributions.

Quick links:

About

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

If you need help installing or using the library, please check the Twilio SendGrid Support Help Center.

If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

License

The MIT License (MIT)