mailme

package module

v1.1.1 Latest Latest Go to latest Published: Oct 25, 2023 License: MIT Imports: 13 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

Repository

README ¶

MailMe - send templated mails

MailMe is meant to deliver transaction mails with a template that can be loaded from a URL. If no template is present from the URL it will fall back to a default template.

This makes it easy to deploy your mail templates to a CDN (with Netlify) and have an easy workflow to work with the mails and preview them directly in the browser.

Documentation ¶

Index ¶

Constants
type MailTemplate
type Mailer
- func (m *Mailer) Mail(to, subjectTemplate, templateURL, defaultTemplate string, ...) error
- func (m *Mailer) MailBody(url string, defaultTemplate string, data map[string]interface{}) (string, error)
type TemplateCache
- func (t *TemplateCache) Get(url string) (*template.Template, error)
- func (t *TemplateCache) Set(key, value string, expirationTime time.Duration) (*template.Template, error)

Constants ¶

View Source

const TemplateExpiration = 10 * time.Second

TemplateExpiration is the time period that the template will be cached for

View Source

const TemplateRetries = 3

TemplateRetries is the amount of time MailMe will try to fetch a URL before giving up

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type MailTemplate ¶

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

type Mailer ¶

type Mailer struct {
	From    string
	Host    string
	Port    int
	User    string
	Pass    string
	BaseURL string
	FuncMap template.FuncMap

	Logger logrus.FieldLogger
	// contains filtered or unexported fields
}

Mailer lets MailMe send templated mails

func (*Mailer) Mail ¶

func (m *Mailer) Mail(to, subjectTemplate, templateURL, defaultTemplate string, templateData map[string]interface{}) error

Mail sends a templated mail. It will try to load the template from a URL, and otherwise fall back to the default

func (*Mailer) MailBody ¶

func (m *Mailer) MailBody(url string, defaultTemplate string, data map[string]interface{}) (string, error)

type TemplateCache ¶

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

func (*TemplateCache) Get ¶

func (t *TemplateCache) Get(url string) (*template.Template, error)

func (*TemplateCache) Set ¶

func (t *TemplateCache) Set(key, value string, expirationTime time.Duration) (*template.Template, error)

Source Files ¶

View all Source files

mailme.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL