mailgun

README

mailgun

Package mailgun wraps the official client to provide unit test utilities and simplify the usage.

Install

import (
	"libs.altipla.consulting/mailgun"
)

Contributing

You can make pull requests or create issues in GitHub. Any code you send should be formatted using make gofmt.

Running tests

Run the tests:

make test

License

MIT License

Documentation

Overview

Package mailgun wraps the official client to provide unit test utilities and simplify the usage.

Index

• Variables
• type Attachment
• type Client
  • func NewClient(apiKey string) *Client
  • func (client *Client) Send(ctx context.Context, domain string, email *Email) error
  • func (client *Client) SendReturnID(ctx context.Context, domain string, email *Email) (string, error)
  • func (client *Client) ValidateEmail(ctx context.Context, email string) (bool, error)
• type Email
• type Sender
• type SenderReturnID
• type Validator

Variables

var (
	ErrTimeout        = errors.New("timeout")
	ErrInvalidAddress = errors.New("invalid address")
)

Types

type Attachment

type Attachment struct {
	Filename string
	Content  []byte
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(apiKey string) *Client

func (*Client) Send

func (client *Client) Send(ctx context.Context, domain string, email *Email) error

func (*Client) SendReturnID

func (client *Client) SendReturnID(ctx context.Context, domain string, email *Email) (string, error)

func (*Client) ValidateEmail

func (client *Client) ValidateEmail(ctx context.Context, email string) (bool, error)

type Email

type Email struct {
	From          mail.Address
	To            mail.Address
	Subject       string
	HTML          string
	Tags          []string
	ReplyTo       string
	Attachments   []*Attachment
	UserVariables map[string]string
}

type Sender

type Sender interface {
	Send(ctx context.Context, domain string, email *Email) error
}

type SenderReturnID

type SenderReturnID interface {
	SendReturnID(ctx context.Context, domain string, email *Email) (string, error)
}

type Validator

type Validator interface {
	ValidateEmail(ctx context.Context, email string) (bool, error)
}