mailman

Documentation

Overview

Package mailman provides an HTTP Oauth2 based module that sends email using Gmail API.

Index

• type Config
• type Mailman
  • func New(c *Config) *Mailman
  • func (m *Mailman) Router() *aries.Router
  • func (m *Mailman) Send(ctx context.Context, from string, body []byte) (string, error)
• type SendRequest
• type Tokens

Types

type Config

type Config struct {
	App      *oauth2.App
	StateKey []byte
	Tokens   Tokens
}

Config contains configuration for a mailman.

type Mailman

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

Mailman is a http server module for sending emails using gmail's OAuth2 API.

func New

func New(c *Config) *Mailman

New creates a new mailman.

func (*Mailman) Router

func (m *Mailman) Router() *aries.Router

Router returns the mailman module router.

func (*Mailman) Send

func (m *Mailman) Send(
	ctx context.Context, from string, body []byte,
) (string, error)

Send sends an email. Needs to setup OAuth2 first.

type SendRequest

type SendRequest struct {
	From string
	Body []byte
}

SendRequest is an request for sending a mail.

type Tokens

type Tokens interface {
	Get(ctx context.Context, email string) (*goauth2.Token, error)
	Set(ctx context.Context, email string, t *goauth2.Token) error
}

Tokens is an interface that gets and fetches an OAuth2 refresh token.