validation

package module

v0.1.1 Latest Latest Go to latest Published: Apr 2, 2021 License: MIT Imports: 7 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

github.com/sensebox/sensebox-mailer-templates

Links

Open Source Insights

README ¶

sensebox-mailer-templates

Dieses Repository enthält die E-Mail Templates für den sensebox-mailer

Templates

Templates liegen im ./templates Verzeichnis und werden in Markdown geschrieben.

Die einzelnen Templates liegen jeweils in Deutsch und Englisch vor. Beide Sprachen werden zusammen in einer Datei abgelegt.

Jedes Template beginnt mit einer so genannten "Frontmatter", welche Metadaten des Templates enthält. Diese beginnt und endet mit einer Zeile, welche nur --- enthält.

Feld	Erklärung
`name`	Name des Templates wie er vom Mailer genannt wird. (Feld `template` im mailer request payload)
`language`	Sprache des Templates. Entweder `de` oder `en`.
`subject`	Der Betreff der Mail.
`fromName`	Der Name des Absenders.

Die Felder und deren Werte in der "Frontmatter" werden jeweils mit einem Doppelpunkt getrennt. Das Frontmatter sollte als YAML formatiert sein.

Die jeweils deutsche oder englische Version eines Templates mit gleichem name Feld befindet sich in einer Datei. Dabei folgt eine Datei immer dem Schema:

---
language: de
fromName: openSenseMap
name: newBoxHackAir
subject: Dein neues Gerät auf der openSenseMap
---

Hallo {{ .user.name }},

...

---
language: en
fromName: openSenseMap
name: newBoxHackAir
subject: Your device on openSenseMap
---

Hello {{ .user.name }},

...

Documentation ¶

Index ¶

type Template
- func Slurp(input io.Reader) ([]Template, error)
- func (t *Template) ConvertAndExecute(payload map[string]interface{}) ([]byte, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Template ¶

type Template struct {
	Language          string `yaml:"language"`
	Name              string `yaml:"name"`
	Subject           string `yaml:"subject"`
	FromName          string `yaml:"fromName"`
	RequireAttachment bool   `yaml:"requireAttachment,omitempty"`
	*template.Template
}

func Slurp ¶

func Slurp(input io.Reader) ([]Template, error)

func (*Template) ConvertAndExecute ¶

func (t *Template) ConvertAndExecute(payload map[string]interface{}) ([]byte, error)

Source Files ¶

View all Source files

validation.go

Directories ¶

Path	Synopsis
validation module

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