mailopen

README

Mailopen

Mailopen is a buffalo mailer that allows to see sent emails in the browser instead of sending these using SMTP or other sender used in production environments.

Usage

Mailopen is only intended for development purposes, the way you use it is by simply initialyzing your mailer to be a mailopen instance instead of your regular sender, p.e:

import (
    ...
    "github.com/gobuffalo/buffalo/mail"
    sendgrid "github.com/paganotoni/sendgrid-sender"
    ...
)

//Sender allows us to send emails
var Sender mail.Sender

func init() {
    sgSender := sendgrid.NewSendgridSender(envy.Get("SENDGRID_API_KEY", ""))
    Sender = mailopen.Wrap(sgSender)
}

Internally Wrap function returns mailopen.FileSender instance only if GO_ENV is development, otherwise it will return passed sender.

You can always write it yourself in case your conditions to switch sender are not only to be in the development environment.

import (
    ...
    "github.com/gobuffalo/buffalo/mail"
    sendgrid "github.com/paganotoni/sendgrid-sender"
    ...
)

func init() {
    if envy.Get("GO_ENV", "development") == "development" {
        Sender = mailopen.New()
		return
    }

    Sender = sendgrid.NewSendgridSender(envy.Get("SENDGRID_API_KEY", ""))
}

Then you will use your Sender instance as usual by calling Sender.Send(m) with the variant that in development it will open your emails in the browser.

Documentation

Index

• Variables
• func Wrap(sender mail.Sender) mail.Sender
• type AttFile
• type FileSender
  • func New() FileSender
  • func (ps FileSender) Send(m mail.Message) error

Variables

var Testing = false

Functions

func Wrap

func Wrap(sender mail.Sender) mail.Sender

Wrap other sender to be used if env is not development

Types

type AttFile

type AttFile struct {
	Path string
	Name string
}

type FileSender

type FileSender struct {
	Open    bool
	TempDir string
}

FileSender implements the Sender interface to be used within buffalo mailer generated package.

func New

func New() FileSender

New creates a sender that writes emails into disk

func (FileSender) Send

func (ps FileSender) Send(m mail.Message) error

Send sends an email to Sendgrid for delivery, it assumes bodies[0] is HTML body and bodies[1] is text.