SparkPost client library for the Go Programming Language
Switch branches/tags
Nothing to show
Clone or download
yargevad Merge pull request #139 from SparkPost/ISSUE-138
cmd line arg for campaign id
Latest commit 1190f47 Jun 7, 2018
Permalink
Failed to load latest commit information.
cmd cmd line arg for campaign id Jun 7, 2018
events fix vet warnings May 22, 2018
examples more on the "why" of cc and bcc Jun 3, 2016
helpers fix vet warnings May 22, 2018
test improve MessageEventsSearch tests Apr 27, 2017
.gitignore Adding suppression list cursor abstractions and more unit tests for s… Apr 4, 2017
.travis.yml multiple patterns should be comma-separated Mar 31, 2017
AUTHORS.rst
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
common.go
common_test.go
del_metrics.go
del_metrics_test.go assert that we have the expected number of errors Jan 20, 2017
event_docs.go avoid calling `ReadBody` directly, instead return the body from `Asse… May 10, 2017
event_docs_test.go the rest of the "context in its own param" changes Feb 18, 2017
macros.go close `httptest` server when we're done with it; add/update comments Jan 31, 2018
macros_test.go
message_events.go
message_events_test.go fix vet warnings May 22, 2018
recipient_lists.go avoid calling `ReadBody` directly, instead return the body from `Asse… May 10, 2017
recipient_lists_test.go test that `[]RecipientList` is parsed as expected Apr 13, 2017
subaccounts.go
subaccounts_test.go remove some more client-side checks, in favor of what the server retu… Apr 17, 2017
suppression_list.go
suppression_list_test.go move json files into a subdirectory under `test` Apr 11, 2017
templates.go simplify type stringification in errors May 22, 2018
templates_test.go
transmissions.go Merge pull request #136 from bontibon/veterrors2 May 22, 2018
transmissions_test.go merge master Mar 31, 2017
vars_test.go
webhooks.go avoid calling `ReadBody` directly, instead return the body from `Asse… May 10, 2017
webhooks_test.go

README.rst

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

SparkPost Go API client

Build Status Code Coverage 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