mail

Documentation

Index

• type IMailClient
  • func NewMailClient(config MailConfig) (IMailClient, error)
• type IMailMessage
• type MailConfig
• type MailMessageAttachment
• type TemplateName

Types

type IMailClient

type IMailClient interface {
	MailUsr() string
	CreateTextMessage() IMailMessage
	CreateHtmlMessage() IMailMessage
	CreateJsonMessage() IMailMessage
	CreateTemplateMessage(template TemplateName, variables map[string]string) IMailMessage
}

IMailClient Mail client interface

func NewMailClient

func NewMailClient(config MailConfig) (IMailClient, error)

NewMailClient is a Mail client factory method

type IMailMessage

type IMailMessage interface {
	From(from string) IMailMessage
	To(to []string) IMailMessage
	Cc(cc []string) IMailMessage
	Subject(subject string) IMailMessage
	Body(body string) IMailMessage
	HtmlBody(html string) IMailMessage
	Attachments(attachments []MailMessageAttachment) IMailMessage
	Send() error
}

IMailMessage Mail message interface

type MailConfig

type MailConfig struct {

	// Mail relay URI (type://host:port)
	MailRelayUri string

	// Mail Relay User
	MailRelayUser string

	// Mail Relay Password
	MailRelayPassword string

	// Flag to use TLS encrypted connection
	UseTLS bool
}

MailConfig Configure mail client parameters

type MailMessageAttachment

type MailMessageAttachment struct {
	// The full file path to attach
	FileName string

	// MIME type, ignore this field, it will be set automatically
	ContentType string

	// Base64 content of the file (ignore this field)
	Base64Content string
}

MailMessageAttachment represents message attachment

type TemplateName

type TemplateName string