mailgun

README

mailgun

Wraps the official client to provide unit test utilities and simplify the usage.

Basic usage

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

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) ValidateEmail(ctx context.Context, email string) (bool, error)
• type Email
• type InvalidToEmailError
  • func (err InvalidToEmailError) Error() string
• type SendRejectedError
  • func (err SendRejectedError) Error() string
• type Sender
• type Validator

Variables

var (
	ErrTimeout = fmt.Errorf("mailgun: timeout")
)

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) 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
}

type InvalidToEmailError

type InvalidToEmailError struct {
	Email string
}

func (InvalidToEmailError) Error

func (err InvalidToEmailError) Error() string

type SendRejectedError

type SendRejectedError struct {
	Reason string
}

func (SendRejectedError) Error

func (err SendRejectedError) Error() string

type Sender

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

type Validator

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