mail

package

v1.5.4 Latest Latest Go to latest Published: Aug 15, 2017 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var Production = false

Production should be set to true in production environment.

func RenderTemplate(email *Email, context Context) (string, error)

RenderTemplate renders the email into its template with context.

func Send(email *Email, context Context) error

Send the email using our default adapter and optional context.

type Context map[string]interface{}

Context defines a simple list of string:value pairs for mail templates.

type Email struct {
	Recipients []string
	ReplyTo    string
	Subject    string
	Body       string
	Template   string
	Layout     string
}

Email represents an email to be sent.

func New(r string) *Email

New returns a new email with the default tenplates and the given recipient.

func (e *Email) Invalid() bool

Invalid returns true if this email is not ready to send.

func (e *Email) String() string

String returns a formatted string representation for debug.

type Sender interface {
	Send(email *Email) error
}

Sender is the interface for our adapters for mail services.

var Service Sender

Service is the mail adapter to send with and should be set on startup.

Path	Synopsis
adapters
sendgrid