mail

Documentation

Index

• type IMailClient
  • func NewMailClient(config MailConfig) (IMailClient, error)
• type IMailMessage
• type MailConfig
  • func NewMailConfig(uri string) *MailConfig
  • func (mc *MailConfig) CreateClient() (IMailClient, error)
  • func (mc *MailConfig) SetHeader(header, value string) *MailConfig
  • func (mc *MailConfig) WithPassword(value string) *MailConfig
  • func (mc *MailConfig) WithTLS(value bool) *MailConfig
  • func (mc *MailConfig) WithUser(value string) *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
	Bcc(bcc []string) IMailMessage
	Subject(subject string) IMailMessage
	Body(body string) IMailMessage
	HtmlBody(html string) IMailMessage
	Attachments(attachments []MailMessageAttachment) IMailMessage

	AddTo(to ...string) IMailMessage
	AddCc(cc ...string) IMailMessage
	AddBcc(bcc ...string) IMailMessage
	AddAttachments(attachments ...MailMessageAttachment) IMailMessage
	Attach(paths ...string) 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 (applicable for SMTP mail only)
	UseTLS bool

	// List of HTTP headers (applicable for HTTP mail only)
	Headers map[string]string
}

MailConfig Configure mail client parameters

func NewMailConfig

func NewMailConfig(uri string) *MailConfig

NewMailConfig factory method

func (*MailConfig) CreateClient

func (mc *MailConfig) CreateClient() (IMailClient, error)

CreateClient create concrete implementation of mail client

func (*MailConfig) SetHeader

func (mc *MailConfig) SetHeader(header, value string) *MailConfig

SetHeader set HTTP header

func (*MailConfig) WithPassword

func (mc *MailConfig) WithPassword(value string) *MailConfig

WithPassword set mail relay password

func (*MailConfig) WithTLS

func (mc *MailConfig) WithTLS(value bool) *MailConfig

WithTLS set TLS flag

func (*MailConfig) WithUser

func (mc *MailConfig) WithUser(value string) *MailConfig

WithUser set mail relay user

type MailMessageAttachment

type MailMessageAttachment struct {
	// File name or the full file path (in case the file content is not provided) to attach
	FileName string `json:"fileName"`

	// Base64 content of the file
	Content string `json:"content"`

	// MIME type, if the content is provided as base64 in the Content field, it should include the suffix: ;base64
	ContentType string `json:"contentType"`
}

MailMessageAttachment represents message attachment

type TemplateName

type TemplateName string