unione

README

UniOne

Send transactional emails with one.unisender.com. Examples and documentation available on godoc.

Usage

Send email

package main

import (
    "log"

    "github.com/alexeyco/unione"
    "github.com/alexeyco/unione/message"
)

func main() {
	recipient := message.NewRecipient("recipient@example.com").
		Name("John Doe")

	msg := message.NewMessage().
		From("site@example.com", "My site").
		To(recipient).
		Subject("Awesome news, buddy").
		BodyPlainText("Return to my site and enjoy")

	client := unione.New("username", "api-key")

	if err := client.Send(msg); err != nil {
		log.Fatalln(err)
	}
}

License

MIT License

Copyright (c) 2019 Alexey Popov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Documentation

Index

• Constants
• type Client
  • func New(userName, apiKey string) Client
• type Response

Constants

const (
	// Endpoint Unione API endpoint.
	Endpoint = "https://one.unisender.com"

	// DefaultLanguage default API language.
	DefaultLanguage = "en"
)

Types

type Client

type Client interface {
	// LanguageEn sets API response language to English (default).
	LanguageEn() Client

	// LanguageRu sets API response language to Russian.
	LanguageRu() Client

	// Client setter for custom http client.
	Client(client *http.Client) Client

	// Send sends transactional email to recipients.
	//
	// See: https://one.unisender.com/en/docs/page/send
	Send(m message.Message) (success []string, failed map[string]error, err error)
}

Client Unione API client interface.

func New

func New(userName, apiKey string) Client

New returns new Unione API client.

type Response

type Response struct {
	// Status specifies if the request was successful.
	Status string `json:"status"`

	// JobID unique identifier of the executed sending.
	JobID string `json:"job_id,omitempty"`

	// Emails array, contains the email addresses where the sending was successful.
	Emails []string `json:"emails,omitempty"`

	// FailedEmails object, contains emails to which the sending for some reasons has not been carried out.
	// The object is filled in format: “address” : “state”
	FailedEmails map[string]string `json:"failed_emails,omitempty"`

	// Code API error code.
	// See: https://one.unisender.com/en/docs/page/Error_Codes
	Code int `json:"code,omitempty"`

	// Message API error message.
	Message string `json:"message,omitempty"`
}

Response Unione API response object.