Postmark

Fork from Keighl's Postmark (A Golang package for the using Postmark API)

Installation

go get -u github.com/mrz1836/postmark

Basic Usage

Grab your Server Token, and your Account Token.

package main

import (
	"context"

	"github.com/mrz1836/postmark"
)

func main() {
	client := postmark.NewClient("[SERVER-TOKEN]", "[ACCOUNT-TOKEN]")

	email := postmark.Email{
		From:       "no-reply@example.com",
		To:         "tito@example.com",
		Subject:    "Reset your password",
		HTMLBody:   "...",
		TextBody:   "...",
		Tag:        "pw-reset",
		TrackOpens: true,
	}

	_, err := client.SendEmail(context.Background(), email)
	if err != nil {
		panic(err)
	}
}

Swap out HTTPClient for use on Google App Engine:

package main

import (
    "github.com/mrz1836/postmark"
    "google.golang.org/appengine"
    "google.golang.org/appengine/urlfetch"
)

// ....

client := postmark.NewClient("[SERVER-TOKEN]", "[ACCOUNT-TOKEN]")

ctx := appengine.NewContext(req)
client.HTTPClient = urlfetch.Client(ctx)

// ...

API Coverage

• Emails
  • POST /email
  • POST /email/batch
  • POST /email/withTemplate
  • POST /email/batchWithTemplates
• Bounces
  • GET /deliverystats
  • GET /bounces
  • GET /bounces/:id
  • GET /bounces/:id/dump
  • PUT /bounces/:id/activate
  • GET /bounces/tags
• Templates
  • GET /templates
  • POST /templates
  • GET /templates/:id
  • PUT /templates/:id
  • DELETE /templates/:id
  • POST /templates/validate
• Suppressions
  • GET /suppressions/dump
  • POST /suppressions
  • POST /suppressions/delete
• Servers
  • GET /servers/:id
  • PUT /servers/:id
• Outbound Messages
  • GET /messages/outbound
  • GET /messages/outbound/:id/details
  • GET /messages/outbound/:id/dump
  • GET /messages/outbound/opens
  • GET /messages/outbound/opens/:id
• Inbound Messages
  • GET /messages/inbound
  • GET /messages/inbound/:id/details
  • PUT /messages/inbound/:id/bypass
  • PUT /messages/inbound/:id/retry
• Message Streams
  • GET /message-streams
  • POST /message-streams
  • GET /message-streams/{stream_ID}
  • PATCH /message-streams/{stream_ID}
  • POST /message-streams/{stream_ID}/archive
  • POST /message-streams/{stream_ID}/unarchive
• Sender signatures
  • GET /senders
  • Get a sender signature’s details
  • Create a signature
  • Edit a signature
  • Delete a signature
  • Resend a confirmation
  • Verify an SPF record
  • Request a new DKIM
• Stats
  • GET /stats/outbound
  • GET /stats/outbound/sends
  • GET /stats/outbound/bounces
  • GET /stats/outbound/spam
  • GET /stats/outbound/tracked
  • GET /stats/outbound/opens
  • GET /stats/outbound/platform
  • Get email client usage
  • Get email read times
• Triggers
  • Tags triggers
    • Create a trigger for a tag
    • Get a single trigger
    • Edit a single trigger
    • Delete a single trigger
    • Search triggers
  • Inbound rules triggers
    • Create a trigger for inbound rule
    • Delete a single trigger
    • List triggers
• Webhooks
  • List webhooks
  • Get webhooks
  • Create webhooks
  • Edit webhooks
  • Delete webhooks

Library Deployment

goreleaser for easy binary or library deployment to GitHub and can be installed via: brew install goreleaser.

The .goreleaser.yml file is used to configure goreleaser.

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.

Makefile Commands

View all makefile commands

make help

List of all current commands:

all                   Runs multiple commands
clean                 Remove previous builds and any test cache data
clean-mods            Remove all the Go mod cache
coverage              Shows the test coverage
diff                  Show the git diff
generate              Runs the go generate command in the base of the repo
godocs                Sync the latest tag with GoDocs
help                  Show this help message
install               Install the application
install-go            Install the application (Using Native Go)
install-releaser      Install the GoReleaser application
lint                  Run the golangci-lint application (install if not found)
release               Full production release (creates release in GitHub)
release               Runs common.release then runs godocs
release-snap          Test the full release (build binaries)
release-test          Full production test release (everything except deploy)
replace-version       Replaces the version in HTML/JS (pre-deploy)
run-examples          Runs all the examples
tag                   Generate a new tag and push (tag version=0.0.0)
tag-remove            Remove a tag if found (tag-remove version=0.0.0)
tag-update            Update an existing tag to current commit (tag-update version=0.0.0)
test                  Runs lint and ALL tests
test-ci               Runs all tests via CI (exports coverage)
test-ci-no-race       Runs all tests via CI (no race) (exports coverage)
test-ci-short         Runs unit tests via CI (exports coverage)
test-no-lint          Runs just tests
test-short            Runs vet, lint and tests (excludes integration tests)
test-unit             Runs tests and outputs coverage
uninstall             Uninstall the application (and remove files)
update-linter         Update the golangci-lint package (macOS only)
vet                   Run the Go vet application

Examples & Tests

All unit tests and examples run via GitHub Actions and uses Go version 1.18.x. View the configuration file.

Run all tests (including integration tests)

make test

Run tests (excluding integration tests)

make test-short

Run the examples:

make run-examples

License