hermes

Documentation

Index

• type Action
• type Body
• type Branding
• type Button
• type Columns
• type Email
  • func (e *Email) SetDefaultEmailValues() error
• type Entry
• type Hermes
  • func (h *Hermes) GenerateHTML(email Email) (string, error)
  • func (h *Hermes) GeneratePlainText(email Email) (string, error)
  • func (h *Hermes) SetDefaultHermesValues() error
• type Markdown
  • func (c Markdown) ToHTML() template.HTML
• type Table
• type Template
• type TextDirection
• type Theme

Types

type Action

type Action struct {
	Instructions string
	Button       Button
	InviteCode   string
}

Action is anything the user can act on (i.e., click on a button, view an invite code)

type Body

type Body struct {
	Name         string   // The name of the contacted person
	Intros       []string // Intro sentences, first displayed in the email
	Dictionary   []Entry  // A list of key+value (useful for displaying parameters/settings/personal info)
	Table        Table    // Table is an table where you can put data (pricing grid, a bill, and so on)
	Actions      []Action // Actions are a list of actions that the user will be able to execute via a button click
	Outros       []string // Outro sentences, last displayed in the email
	Greeting     string   // Greeting for the contacted person (default to 'Hi')
	Signature    string   // Signature for the contacted person (default to 'Yours truly')
	Title        string   // Title replaces the greeting+name when set
	FreeMarkdown Markdown // Free markdown content that replaces all content other than header and footer
}

Body is the body of the email, containing all interesting data

type Branding

type Branding struct {
	Name        string
	Link        string // e.g. https://google.com
	Logo        string // e.g. https://google.com/img/logo.png
	Copyright   string // Copyright © 2024 Hermes. All rights reserved.
	TroubleText string // TroubleText is the sentence at the end of the email for users having trouble with the button (default to `If you’re having trouble with the button '{ACTION}', copy and paste the URL below into your web browser.`)
}

Appears in header & footer of e-mails

type Button

type Button struct {
	Color     string
	TextColor string
	Text      string
	Link      string
}

Button defines an action to launch

type Columns

type Columns struct {
	CustomWidth     map[string]string
	CustomAlignment map[string]string
}

Columns contains meta-data for the different columns

type Email

type Email struct {
	Body Body
}

Email is the email containing a body

func (*Email) SetDefaultEmailValues

func (e *Email) SetDefaultEmailValues() error

type Entry

type Entry struct {
	Key   string
	Value string
}

Entry is a simple entry of a map Allows using a slice of entries instead of a map Because Golang maps are not ordered

type Hermes

type Hermes struct {
	Theme              Theme
	Brand              Branding
	TextDirection      TextDirection
	DisableCSSInlining bool
}

Hermes is an instance of the hermes email generator

func (*Hermes) GenerateHTML

func (h *Hermes) GenerateHTML(email Email) (string, error)

GenerateHTML genera el cuerpo del correo electrónico en formato HTML para clientes modernos.

func (*Hermes) GeneratePlainText

func (h *Hermes) GeneratePlainText(email Email) (string, error)

GeneratePlainText genera el cuerpo del correo electrónico en formato de texto sin formato para clientes antiguos.

func (*Hermes) SetDefaultHermesValues

func (h *Hermes) SetDefaultHermesValues() error

default values of the engine

type Markdown

type Markdown template.HTML

Markdown is a HTML template (a string) representing Markdown content https://en.wikipedia.org/wiki/Markdown

func (Markdown) ToHTML

func (c Markdown) ToHTML() template.HTML

ToHTML converts Markdown to HTML

type Table

type Table struct {
	Data    [][]Entry // Contains data
	Columns Columns   // Contains meta-data for display purpose (width, alignement)
}

Table is an table where you can put data (pricing grid, a bill, and so on)

type Template

type Template struct {
	Hermes Hermes
	Email  Email
}

Template is the struct given to Golang templating Root object in a template is this struct

type TextDirection

type TextDirection string

TextDirection of the text in HTML email

type Theme

type Theme interface {
	Name() string              // The name of the theme
	HTMLTemplate() string      // The golang template for HTML emails
	PlainTextTemplate() string // The golang templte for plain text emails (can be basic HTML)
}

Theme is an interface to implement when creating a new theme