email

package

v0.0.0-...-626c64f Latest Latest Go to latest Published: Nov 29, 2020 License: GPL-3.0 Imports: 5 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/fernandomitre7/chocolate

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Init(cnf config.EmailConfig)
func NewGmail(config config.EmailConfig) (*Gmail, *Error)
func NewSender() (Sender, *Error)
type Email
- func (e Email) FormMessage() (msg string, err error)
type Error
- func NewError(msg string, inner error) *Error
- func (e Error) Error() string
type Gmail
- func (g Gmail) Send(email *Email) (eErr *Error)
type ITemplate
type SES
type Sender
type Type

Constants ¶

View Source

const (
	// TextEmail type for plain text emails
	TextEmail = Type("text")
	// HTMLEmail type for HTML emails
	HTMLEmail = Type("html")
)

Variables ¶

View Source

var Templates map[string]string

Functions ¶

func Init ¶

func Init(cnf config.EmailConfig)

Init initalizes package with correct configurations

func NewGmail ¶

func NewGmail(config config.EmailConfig) (*Gmail, *Error)

NewGmail creates a new Gmail sender

func NewSender ¶

func NewSender() (Sender, *Error)

NewSender creates a new sender depending on the provider specified in EmailConfig

Types ¶

type Email ¶

type Email struct {
	Type     Type
	Subject  string
	Body     string
	From     string
	To       string
	CC       []string
	Template ITemplate
}

Email is the email object to send

func (Email) FormMessage ¶

func (e Email) FormMessage() (msg string, err error)

FormMessage properly forms the Email message in RFC 822-style

type Error ¶

type Error struct {
	Message string
	Inner   error
}

Error structue to handle Email related errors

func NewError ¶

func NewError(msg string, inner error) *Error

NewError creates a new EmailError

func (Error) Error ¶

func (e Error) Error() string

Error returns error string

type Gmail ¶

type Gmail struct {
	Config config.EmailConfig
}

Gmail is the provider to send emails thru google mail

func (Gmail) Send ¶

func (g Gmail) Send(email *Email) (eErr *Error)

Send sends an email

type ITemplate ¶

type ITemplate interface {
	Process() (string, error)
}

ITemplate is the interface to use to be able to have diffent types of templates for emails

type SES ¶

type SES struct {
}

SES is the Email sender for AWS SES

type Sender ¶

type Sender interface {
	Send(*Email) *Error
}

Sender is the object to use for Email

type Type ¶

type Type string

Type of the type of email we are going to send

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
templates
confirm

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