Skip to content

Latest commit

History

86 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

Postmark

Build StatusGo Report Cardcodecov.ioGoDoc

A Golang package for the using Postmark API.

Installation

go get -u github.com/keighl/postmark

Basic Usage

Grab your Server Token, and your Account Token.

import (
"github.com/keighl/postmark"
)
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(email)
iferr!=nil {
panic(err)
}

Swap out HTTPClient for use on Google App Engine:

import (
"github.com/keighl/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
  • 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
  • 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

About

Golang package for the Postmark API

Resources

Stars

0 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages