email

package

v2.0.0+incompatible Latest Latest Go to latest Published: Jan 30, 2019 License: GPL-3.0 Imports: 4 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

Package email handles the configuration of a mail-server, the authentication to this mail-server and creating and sending of emails.

This section is empty.

This section is empty.

func SetAuthentication(auth Authentication)

SetAuthentication sets the authentication for the mail-server

func SetConfiguration(config Configuration)

SetConfiguration sets the configuration of the mail-server

type Authentication struct {
	Username string `name:"smtp-username"`
	Password string `name:"smtp-password"`
}

Authentication is used to authenticate with "Username" and "Password" to the "Hostname" of the Configuration.

func GetAuthentication() Authentication

GetAuthentication returns the authentication for the mail-server

type Configuration struct {
	Hostname string `name:"smtp-hostname"`
	Port     int    `name:"smtp-port"`
}

Configuration contains the information of the mail-server.

func GetConfiguration() Configuration

GetConfiguration returns the configuration of the mail-server

func (c Configuration) GetAddress() string

GetAddress returns the address of the server in the format "hostname:port"

type STPEmail struct {
	email.Email
}

STPEmail wraps the Email type of "github.com/jordan-wright/email"

This makes the sending and configuration of emails easier.

func New(to, bcc, cc []string, subject string, text, html []byte) *STPEmail

New creates a new STPEmail with all the information given.

Returns the email.

func (e STPEmail) AttachFile(filename string) error

AttachFile attaches a file with the given name to the STPEmail.

Returns an error if any occurred.

func (e STPEmail) Send() error

Send sends the STPEmail.

It uses the configured settings for the mail server.

Returns an error if any occurred.