email

package

v0.12.0 Latest Latest Go to latest Published: Mar 29, 2021 License: Apache-2.0 Imports: 6 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

README ¶

Mainflux Email Agent

Mainflux Email Agent is used for sending emails. It wraps basic SMTP features and provides a simple API that Mainflux services can use to send email notifications.

Configuration

Mainflux Email Agent is configured using the following configuration parameters:

Parameter	Description
MF_EMAIL_HOST	Mail server host
MF_EMAIL_PORT	Mail server port
MF_EMAIL_USERNAME	Mail server username
MF_EMAIL_PASSWORD	Mail server password for Basic authentication
MF_EMAIL_SECRET	Mail server secret for CRAM-MD5 authentication
MF_EMAIL_FROM_ADDRESS	Email "from" address
MF_EMAIL_FROM_NAME	Email "from" name
MF_EMAIL_TEMPLATE	Email template for sending notification emails

There are two authentication methods supported: Basic Auth and CRAM-MD5. MF_EMAIL_SECRET indicates that CRAM-MD5 authentication will be used. MF_EMAIL_PASSWORD indicates that Basic authentication will be used. If both MF_EMAIL_SECRET and MF_EMAIL_PASSWORD are present, CRAM-MD5 authentication will be used. If MF_EMAIL_USERNAME is empty or both MF_EMAIL_SECRET and MF_EMAIL_PASSWORD are empty, no authentication will be used.

Documentation ¶

Index ¶

type Agent
- func New(c *Config) (*Agent, error)
- func (a *Agent) Send(To []string, From, Subject, Header, Content, Footer string) error
type Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Agent ¶

type Agent struct {
	// contains filtered or unexported fields
}

Agent for mailing

func New ¶

func New(c *Config) (*Agent, error)

New creates new email agent

func (*Agent) Send ¶

func (a *Agent) Send(To []string, From, Subject, Header, Content, Footer string) error

Send sends e-mail

type Config ¶

type Config struct {
	Host        string
	Port        string
	Username    string
	Password    string
	Secret      string
	FromAddress string
	FromName    string
	Template    string
}

Config email agent configuration.

Source Files ¶

View all Source files

email.go

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