mailgun

README

go-mailgun

Mailgun client in Go

Documentation

Index

• Constants
• Variables
• type Bounce
  • func (b *Bounce) Time() time.Time
• type Complaint
  • func (c *Complaint) Time() time.Time
• type Event
  • func (e *Event) MsgId() string
  • func (e *Event) Name() string
  • func (e *Event) Rcpt() string
  • func (e *Event) Reason() string
  • func (e *Event) Time() time.Time
• type Log
  • func (l *Log) Time() time.Time
• type Mail
• type Mailgun
  • func Open(key string) *Mailgun
  • func (mg *Mailgun) Bounces(domain string, limit, skip int) (total int, res []Bounce, err error)
  • func (mg *Mailgun) Complaints(domain string, limit, skip int) (total int, res []Complaint, err error)
  • func (mg *Mailgun) Logs(domain string, limit, skip int) (total int, res []Log, err error)
  • func (mg *Mailgun) Send(m Mail) (msgId string, err error)
  • func (mg *Mailgun) Stats(domain string, limit, skip int, events []string, startDate time.Time) (total int, res []Stat, err error)
• type Stat
  • func (s *Stat) Time() time.Time
• type Webhook
  • func NewWebhook(key string) *Webhook
  • func (wh *Webhook) Handle(w http.ResponseWriter, req *http.Request) (evt *Event, err error)
  • func (wh *Webhook) Verify(timestamp, token, signature string) bool

Constants

const (
	API_VERSION  = 2
	API_ENDPOINT = "api.mailgun.net"
)

const MAX_FORM_SIZE = 2 * 1024 * 1024

Variables

var (
	ErrMethodNotAllowed = fmt.Errorf("method not allowed")
	ErrBadSignature     = fmt.Errorf("bad signature")
	ErrInvalidTimestamp = fmt.Errorf("invalid timestamp")
	ErrInvalidForm      = fmt.Errorf("invalid form data")
)

var EMAIL_DOMAIN_RE = regexp.MustCompile(`[^<>]+<?.+@([^<>]+)>?`)

Types

type Bounce

type Bounce struct {
	Code      int    `json:"code"`
	CreatedAt string `json:"created_at"`
	Error     string `json:"error"`
	Address   string `json:"address"`
}

func (*Bounce) Time

func (b *Bounce) Time() time.Time

type Complaint

type Complaint struct {
	Count     int    `json:"count"`
	CreatedAt string `json:"created_at"`
	Address   string `json:"address"`
}

func (*Complaint) Time

func (c *Complaint) Time() time.Time

type Event

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

func (*Event) MsgId

func (e *Event) MsgId() string

func (*Event) Name

func (e *Event) Name() string

func (*Event) Rcpt

func (e *Event) Rcpt() string

func (*Event) Reason

func (e *Event) Reason() string

func (*Event) Time

func (e *Event) Time() time.Time

type Log

type Log struct {
	Hap       string `json:"hap"`
	CreatedAt string `json:"created_at"`
	Message   string `json:"message"`
	Type      string `json:"type"`
	MessageId string `json:"message_id"`
}

func (*Log) Time

func (l *Log) Time() time.Time

type Mail

type Mail interface {
	From() string
	To() []string
	Cc() []string
	Bcc() []string
	Subject() string
	Html() string
	Text() string
	Headers() map[string]string
	Options() map[string]string
	Variables() map[string]string
}

type Mailgun

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

func Open

func Open(key string) *Mailgun

func (*Mailgun) Bounces

func (mg *Mailgun) Bounces(domain string, limit, skip int) (total int, res []Bounce, err error)

func (*Mailgun) Complaints

func (mg *Mailgun) Complaints(domain string, limit, skip int) (total int, res []Complaint, err error)

func (*Mailgun) Logs

func (mg *Mailgun) Logs(domain string, limit, skip int) (total int, res []Log, err error)

func (*Mailgun) Send

func (mg *Mailgun) Send(m Mail) (msgId string, err error)

func (*Mailgun) Stats

func (mg *Mailgun) Stats(domain string, limit, skip int, events []string, startDate time.Time) (total int, res []Stat, err error)

type Stat

type Stat struct {
	Count     int            `json:"total_count"`
	CreatedAt string         `json:"created_at"`
	Tags      map[string]int `json:"tags"`
	Id        string         `json:"id"`
	Event     string         `json:"event"`
}

func (*Stat) Time

func (s *Stat) Time() time.Time

type Webhook

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

func NewWebhook

func NewWebhook(key string) *Webhook

func (*Webhook) Handle

func (wh *Webhook) Handle(w http.ResponseWriter, req *http.Request) (evt *Event, err error)

func (*Webhook) Verify

func (wh *Webhook) Verify(timestamp, token, signature string) bool