SparkPost client library for the Go Programming Language
Go
Latest commit b7ff099 Mar 7, 2017 @yargevad yargevad committed on GitHub Merge pull request #85 from SparkPost/ISSUE-12
build status badge for master
Permalink
Failed to load latest commit information.
cmd pull flag variables into main to make goveralls not explode Mar 8, 2017
events Remove ErrWebhookValidation (see #52) May 14, 2016
examples more on the "why" of cc and bcc Jun 3, 2016
helpers/loadmsg remove dkim from message loading helper Jul 28, 2016
test start work to support public event docs endpoint Nov 15, 2016
.gitignore ignore vim swap files Oct 5, 2015
.travis.yml coveralls config for travis Mar 8, 2017
AUTHORS.rst Issue # 26: Fixes problem where Timestamp was getting decoded as int6… Feb 11, 2016
CONTRIBUTING.md Fixes some typo for branching project Feb 11, 2016
LICENSE apache 2.0 license, with message systems copyright Oct 6, 2015
README.rst build status badge for master Mar 8, 2017
common.go update docs on concurrency wrt Client (and Client.headers); update AP… Mar 7, 2017
common_test.go add a couple transmission tests; move tests into their own test-speci… Dec 9, 2016
del_metrics.go the rest of the "context in its own param" changes Feb 18, 2017
del_metrics_test.go assert that we have the expected number of errors Jan 20, 2017
event_docs.go the rest of the "context in its own param" changes Feb 18, 2017
event_docs_test.go the rest of the "context in its own param" changes Feb 18, 2017
message_events.go the rest of the "context in its own param" changes Feb 18, 2017
message_events_test.go move params and context into `EventPage`; pass context through to htt… Jan 20, 2017
recipient_lists.go recipient lists: break context out into its own param Feb 17, 2017
recipient_lists_test.go temporarily disable tests that make api calls, so travis reports buil… Jan 22, 2016
subaccounts.go subaccounts: break context out into its own param Feb 17, 2017
suppression_list.go the rest of the "context in its own param" changes Feb 18, 2017
suppression_list_test.go add a couple transmission tests; move tests into their own test-speci… Dec 9, 2016
template_from_json_test.go remove hyphen from repo name so it can be used as a go package name Jan 9, 2016
templates.go templates: break context out into its own param Feb 17, 2017
templates_test.go support for using an Address in Content.From (ignores Address.HeaderTo) Jul 27, 2016
transmissions.go Merge branch 'master' into ISSUE-59-1 Feb 18, 2017
transmissions_test.go refactor so context is a separate parameter Feb 17, 2017
webhooks.go webhooks: break context out into its own param Feb 17, 2017

README.rst

Sign up for a SparkPost account and visit our Developer Hub for even more content.

SparkPost Go API client

Build Status Slack Community

The official Go package for using the SparkPost API.

Installation

Install from GitHub using go get:

$ go get github.com/SparkPost/gosparkpost

Get a key

Go to API & SMTP in the SparkPost app and create an API key. We recommend using the SPARKPOST_API_KEY environment variable. The example code below shows how to set this up.

Send a message

Here at SparkPost, our "send some messages" api is called the transmissions API - let's use it to send a friendly test message:

package main

import (
  "log"
  "os"

  sp "github.com/SparkPost/gosparkpost"
)

func main() {
  // Get our API key from the environment; configure.
  apiKey := os.Getenv("SPARKPOST_API_KEY")
  cfg := &sp.Config{
    BaseUrl:    "https://api.sparkpost.com",
    ApiKey:     apiKey,
    ApiVersion: 1,
  }
  var client sp.Client
  err := client.Init(cfg)
  if err != nil {
    log.Fatalf("SparkPost client init failed: %s\n", err)
  }

  // Create a Transmission using an inline Recipient List
  // and inline email Content.
  tx := &sp.Transmission{
    Recipients: []string{"someone@somedomain.com"},
    Content: sp.Content{
      HTML:    "<p>Hello world</p>",
      From:    "test@sparkpostbox.com",
      Subject: "Hello from gosparkpost",
    },
  }
  id, _, err := client.Send(tx)
  if err != nil {
    log.Fatal(err)
  }

  // The second value returned from Send
  // has more info about the HTTP response, in case
  // you'd like to see more than the Transmission id.
  log.Printf("Transmission sent with id [%s]\n", id)
}

Documentation

Contribute

TL;DR:

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the repository.
  3. Go get the original code - go get https://github.com/SparkPost/gosparkpost
  4. Add your fork as a remote - git remote add fork http://github.com/YOURID/gosparkpost
  5. Make your changes in a branch on your fork
  6. Write a test which shows that the bug was fixed or that the feature works as expected.
  7. Push your changes - git push fork HEAD
  8. Send a pull request. Make sure to add yourself to AUTHORS.

More on the contribution process