Skip to content

Virtomize/mailtrain-go-api

Repository files navigation

mailtrain-go-api

Donate GoDoc Go Report Card License Build Status Built with Mage

Implements the mailtrain API.

!!! less tested !!!

Installation

If you already installed GO on your system and configured it properly than its simply:

go get github.com/virtomize/mailtrain-go-api

If not follow these instructions

Usage

Simple example

  api, err := gomailtrain.NewAPI("https://mailtrain.example.com", "token")
  if err != nil {
    // handle error
  }

  // read all subscribed lists for an email
  lists, err := api.GetListsByEmail("mail@example.com")
  if err != nil {
    // handle error
  }

Advanced examples

see examples for some more usage examples

Code Documentation

You find the full code documentation here.

Contribution

Thank you for participating to this project. Please see our Contribution Guidlines for more information.